From 5913c5133012f3d6c70e4f098a8b52a0b50019e9 Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Tue, 9 Apr 2024 00:34:16 -0700 Subject: [PATCH] chore: Update discovery artifacts (#2377) ## Deleted keys were detected in the following stable discovery artifacts: aiplatform v1 https://togithub.com/googleapis/google-api-python-client/commit/401ef21a843cd2dc126712165e812956a0c93345 ## Deleted keys were detected in the following pre-stable discovery artifacts: aiplatform v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/401ef21a843cd2dc126712165e812956a0c93345 discoveryengine v1alpha https://togithub.com/googleapis/google-api-python-client/commit/9813760749815bdb0ff3460bb08ab7d25479cc8f discoveryengine v1beta https://togithub.com/googleapis/google-api-python-client/commit/9813760749815bdb0ff3460bb08ab7d25479cc8f ## Discovery Artifact Change Summary: feat(advisorynotifications): update the api https://togithub.com/googleapis/google-api-python-client/commit/16da4befc59e936210123916f323aba1e37f9ea0 feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/401ef21a843cd2dc126712165e812956a0c93345 feat(analyticsadmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/dd2c666accfdb01888eed3e3ccf20dbbf81a8f87 feat(androidpublisher): update the api https://togithub.com/googleapis/google-api-python-client/commit/5a7de4fb9e4ef1f9d1dc2e2c1c0d310b2112ae06 feat(cloudsupport): update the api https://togithub.com/googleapis/google-api-python-client/commit/4fa66528f72f453d3221512d46a6a1b7132dad54 feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/9491c2d2ade9c6ed8b71192441946859e934df49 feat(content): update the api https://togithub.com/googleapis/google-api-python-client/commit/9d36e11d6da4fde7b27eee96e83eb54c28781eda fix(dataportability): update the api https://togithub.com/googleapis/google-api-python-client/commit/beecc6f647c7a2e0371f9a5cd76eb521ca4f7e16 feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/9813760749815bdb0ff3460bb08ab7d25479cc8f feat(dlp): update the api https://togithub.com/googleapis/google-api-python-client/commit/a40526d3c06af89f2fa7bcf8cb2f81df48fbd093 feat(documentai): update the api https://togithub.com/googleapis/google-api-python-client/commit/60effdf97de06e44b46534368e44dfe74cddef21 feat(integrations): update the api https://togithub.com/googleapis/google-api-python-client/commit/13c8868562f7c74abf2027c85a0b5c7545109691 feat(paymentsresellersubscription): update the api https://togithub.com/googleapis/google-api-python-client/commit/51db113f9dd822a8ca780f95f835818c372b0a97 feat(trafficdirector): update the api https://togithub.com/googleapis/google-api-python-client/commit/7e1738fed5365f4dfa02ee8905bc8c84adeb8420 feat(verifiedaccess): update the api https://togithub.com/googleapis/google-api-python-client/commit/3569331b4e20c4f416455bf47dd82c121fdb881d --- ...ifications_v1.organizations.locations.html | 10 +- ...organizations.locations.notifications.html | 2 +- ...rynotifications_v1.projects.locations.html | 69 + ...s_v1.projects.locations.notifications.html | 2 +- ...tform_v1.projects.locations.endpoints.html | 8 +- ..._v1.projects.locations.indexEndpoints.html | 2 +- ...rojects.locations.persistentResources.html | 56 +- ....projects.locations.publishers.models.html | 8 +- ...form_v1.projects.locations.tuningJobs.html | 621 +++ docs/dyn/aiplatform_v1.publishers.models.html | 81 - docs/dyn/aiplatform_v1beta1.html | 5 - docs/dyn/aiplatform_v1beta1.projects.html | 69 + ...ta1.projects.locations.endpoints.chat.html | 127 + ..._v1beta1.projects.locations.endpoints.html | 7 + ...v1beta1.projects.locations.extensions.html | 75 + ...aiplatform_v1beta1.projects.locations.html | 77 +- ...ta1.projects.locations.indexEndpoints.html | 2 +- ...rojects.locations.persistentResources.html | 8 +- ....projects.locations.publishers.models.html | 2 + ...v1beta1.projects.locations.ragCorpora.html | 164 - ...rojects.locations.ragCorpora.ragFiles.html | 211 - .../aiplatform_v1beta1.publishers.models.html | 162 - .../analyticsadmin_v1alpha.properties.html | 5 + ...icsadmin_v1alpha.properties.keyEvents.html | 288 ++ .../dyn/analyticsadmin_v1beta.properties.html | 5 + ...ticsadmin_v1beta.properties.keyEvents.html | 288 ++ ...roidmanagement_v1.enterprises.devices.html | 2 +- ...oidmanagement_v1.enterprises.policies.html | 8 +- ...zation.subscriptions.basePlans.offers.html | 96 + docs/dyn/calendar_v3.events.html | 4 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 216 +- docs/dyn/cloudsupport_v2.cases.comments.html | 36 +- .../cloudsupport_v2beta.cases.comments.html | 36 +- docs/dyn/compute_alpha.interconnects.html | 56 + ...e_alpha.regionNetworkFirewallPolicies.html | 1 + docs/dyn/compute_alpha.regionUrlMaps.html | 48 +- docs/dyn/compute_alpha.urlMaps.html | 56 +- docs/dyn/compute_beta.regionUrlMaps.html | 48 +- docs/dyn/compute_beta.urlMaps.html | 56 +- docs/dyn/compute_v1.regionUrlMaps.html | 48 +- docs/dyn/compute_v1.urlMaps.html | 56 +- docs/dyn/content_v2_1.merchantsupport.html | 169 + docs/dyn/content_v2_1.products.html | 64 + .../discoveryengine_v1alpha.locations.html | 28 +- ....dataStores.branches.documents.chunks.html | 4 +- ...ections.dataStores.branches.documents.html | 53 +- ....collections.dataStores.conversations.html | 13 +- ...ects.locations.collections.dataStores.html | 5 + ...collections.dataStores.servingConfigs.html | 248 +- ...llections.dataStores.sessions.answers.html | 199 + ...tions.collections.dataStores.sessions.html | 319 ++ ....dataStores.suggestionDenyListEntries.html | 2 +- ...ons.collections.dataStores.userEvents.html | 4 +- ...ons.collections.engines.conversations.html | 13 +- ...rojects.locations.collections.engines.html | 5 + ...ns.collections.engines.servingConfigs.html | 248 +- ....collections.engines.sessions.answers.html | 199 + ...ocations.collections.engines.sessions.html | 319 ++ ....dataStores.branches.documents.chunks.html | 4 +- ...cations.dataStores.branches.documents.html | 53 +- ...ts.locations.dataStores.conversations.html | 13 +- ...v1alpha.projects.locations.dataStores.html | 5 + ...s.locations.dataStores.servingConfigs.html | 248 +- ...locations.dataStores.sessions.answers.html | 199 + ...rojects.locations.dataStores.sessions.html | 319 ++ ....dataStores.suggestionDenyListEntries.html | 2 +- ...jects.locations.dataStores.userEvents.html | 4 +- ...1alpha.projects.locations.evaluations.html | 91 + ...ects.locations.evaluations.operations.html | 124 + ...a.projects.locations.groundingConfigs.html | 145 + ...veryengine_v1alpha.projects.locations.html | 14 +- ...pha.projects.locations.rankingConfigs.html | 2 +- ...ections.dataStores.branches.documents.html | 51 +- ....collections.dataStores.conversations.html | 11 + ...ects.locations.collections.dataStores.html | 5 + ...collections.dataStores.servingConfigs.html | 245 +- ...llections.dataStores.sessions.answers.html | 199 + ...tions.collections.dataStores.sessions.html | 319 ++ ....dataStores.suggestionDenyListEntries.html | 2 +- ...ons.collections.dataStores.userEvents.html | 4 +- ...ons.collections.engines.conversations.html | 11 + ...rojects.locations.collections.engines.html | 5 + ...ns.collections.engines.servingConfigs.html | 245 +- ....collections.engines.sessions.answers.html | 199 + ...ocations.collections.engines.sessions.html | 319 ++ ...cations.dataStores.branches.documents.html | 51 +- ...ts.locations.dataStores.conversations.html | 11 + ..._v1beta.projects.locations.dataStores.html | 5 + ...s.locations.dataStores.servingConfigs.html | 245 +- ...locations.dataStores.sessions.answers.html | 199 + ...rojects.locations.dataStores.sessions.html | 319 ++ ....dataStores.suggestionDenyListEntries.html | 2 +- ...jects.locations.dataStores.userEvents.html | 4 +- ...a.projects.locations.groundingConfigs.html | 145 + ...overyengine_v1beta.projects.locations.html | 5 + ...eta.projects.locations.rankingConfigs.html | 2 +- ...2.organizations.locations.connections.html | 161 + ...anizations.locations.discoveryConfigs.html | 246 + docs/dyn/dlp_v2.organizations.locations.html | 5 + ...2.organizations.locations.jobTriggers.html | 12 +- ...nizations.locations.tableDataProfiles.html | 103 + docs/dyn/dlp_v2.projects.jobTriggers.html | 12 +- ...dlp_v2.projects.locations.connections.html | 482 ++ ...2.projects.locations.discoveryConfigs.html | 246 + docs/dyn/dlp_v2.projects.locations.html | 5 + ...dlp_v2.projects.locations.jobTriggers.html | 12 +- ....projects.locations.tableDataProfiles.html | 103 + ...ocations.processors.processorVersions.html | 12 +- ...ocations.processors.processorVersions.html | 12 +- docs/dyn/firebaseml_v2beta.html | 111 + docs/dyn/firebaseml_v2beta.projects.html | 91 + .../firebaseml_v2beta.projects.locations.html | 91 + ..._v2beta.projects.locations.publishers.html | 91 + ....projects.locations.publishers.models.html | 737 +++ docs/dyn/index.md | 1 + ...alpha.projects.locations.integrations.html | 2 + ...jects.locations.integrations.versions.html | 8 + ...jects.locations.products.integrations.html | 2 + ...ations.products.integrations.versions.html | 8 + ...roducts.integrationtemplates.versions.html | 4 + ...ubscription_v1.partners.subscriptions.html | 8 + docs/dyn/places_v1.places.html | 2 +- docs/dyn/trafficdirector_v3.discovery.html | 16 +- docs/dyn/verifiedaccess_v2.challenge.html | 1 + .../dyn/workspaceevents_v1.subscriptions.html | 2 +- .../acceleratedmobilepageurl.v1.json | 2 +- .../discovery_cache/documents/acmedns.v1.json | 2 +- .../documents/adexchangebuyer2.v2beta1.json | 2 +- .../documents/admin.datatransfer_v1.json | 2 +- .../documents/admin.directory_v1.json | 2 +- .../documents/admin.reports_v1.json | 2 +- .../discovery_cache/documents/admob.v1.json | 2 +- .../documents/admob.v1beta.json | 2 +- .../discovery_cache/documents/adsense.v2.json | 2 +- .../documents/advisorynotifications.v1.json | 67 +- .../documents/aiplatform.v1.json | 749 ++- .../documents/aiplatform.v1beta1.json | 1187 ++--- .../documents/alertcenter.v1beta1.json | 2 +- .../documents/analyticsadmin.v1alpha.json | 246 +- .../documents/analyticsadmin.v1beta.json | 246 +- .../documents/analyticsdata.v1beta.json | 2 +- .../androiddeviceprovisioning.v1.json | 2 +- .../documents/androidenterprise.v1.json | 4 +- .../documents/androidmanagement.v1.json | 8 +- .../documents/androidpublisher.v3.json | 22 +- .../documents/area120tables.v1alpha1.json | 2 +- .../authorizedbuyersmarketplace.v1.json | 2 +- .../documents/billingbudgets.v1.json | 2 +- .../documents/billingbudgets.v1beta1.json | 2 +- .../documents/binaryauthorization.v1.json | 2 +- .../binaryauthorization.v1beta1.json | 2 +- .../discovery_cache/documents/blogger.v2.json | 2 +- .../discovery_cache/documents/blogger.v3.json | 2 +- .../discovery_cache/documents/books.v1.json | 2 +- .../businessprofileperformance.v1.json | 2 +- .../documents/calendar.v3.json | 6 +- .../discovery_cache/documents/chat.v1.json | 116 +- .../documents/checks.v1alpha.json | 2 +- .../documents/chromemanagement.v1.json | 2 +- .../documents/chromepolicy.v1.json | 2 +- .../documents/chromeuxreport.v1.json | 2 +- .../documents/civicinfo.v2.json | 2 +- .../documents/classroom.v1.json | 2 +- .../documents/cloudchannel.v1.json | 2 +- .../documents/cloudidentity.v1.json | 2 +- .../documents/cloudidentity.v1beta1.json | 2 +- .../documents/cloudprofiler.v2.json | 2 +- .../documents/cloudsupport.v2.json | 15 +- .../documents/cloudsupport.v2beta.json | 15 +- .../documents/cloudtrace.v1.json | 2 +- .../documents/cloudtrace.v2.json | 2 +- .../documents/cloudtrace.v2beta1.json | 2 +- .../documents/compute.alpha.json | 95 +- .../documents/compute.beta.json | 10 +- .../discovery_cache/documents/compute.v1.json | 10 +- .../documents/contactcenterinsights.v1.json | 2 +- .../documents/content.v2.1.json | 420 +- .../documents/customsearch.v1.json | 2 +- .../documents/datalineage.v1.json | 2 +- .../documents/dataportability.v1.json | 9 +- .../documents/dataportability.v1beta.json | 9 +- .../documents/dataproc.v1.json | 2 +- .../documents/deploymentmanager.alpha.json | 2 +- .../documents/deploymentmanager.v2.json | 2 +- .../documents/deploymentmanager.v2beta.json | 2 +- .../documents/dialogflow.v2beta1.json | 2 +- .../documents/discoveryengine.v1alpha.json | 2209 +++++++- .../documents/discoveryengine.v1beta.json | 4586 ++++++++++++----- .../documents/displayvideo.v2.json | 14 +- .../documents/displayvideo.v3.json | 16 +- .../discovery_cache/documents/dlp.v2.json | 678 ++- .../documents/documentai.v1.json | 7 +- .../documents/documentai.v1beta2.json | 2 +- .../documents/documentai.v1beta3.json | 7 +- .../documents/domainsrdap.v1.json | 2 +- .../documents/doubleclickbidmanager.v2.json | 2 +- .../discovery_cache/documents/drive.v2.json | 2 +- .../discovery_cache/documents/drive.v3.json | 2 +- .../documents/driveactivity.v2.json | 2 +- .../documents/drivelabels.v2.json | 2 +- .../documents/drivelabels.v2beta.json | 2 +- .../documents/essentialcontacts.v1.json | 2 +- .../documents/factchecktools.v1alpha1.json | 2 +- .../discovery_cache/documents/fcm.v1.json | 2 +- .../documents/fcmdata.v1beta1.json | 2 +- .../documents/firebaseappcheck.v1.json | 2 +- .../documents/firebaseappcheck.v1beta.json | 2 +- .../documents/firebaseappdistribution.v1.json | 2 +- .../firebaseappdistribution.v1alpha.json | 2 +- .../documents/firebasedatabase.v1beta.json | 2 +- .../documents/firebasedynamiclinks.v1.json | 2 +- .../documents/firebasehosting.v1.json | 2 +- .../documents/firebasehosting.v1beta1.json | 2 +- .../documents/firebaseml.v1.json | 2 +- .../documents/firebaseml.v1beta2.json | 2 +- .../documents/firebaseml.v2beta.json | 1156 +++++ .../documents/firebasestorage.v1beta.json | 2 +- .../discovery_cache/documents/fitness.v1.json | 2 +- .../discovery_cache/documents/forms.v1.json | 2 +- .../discovery_cache/documents/games.v1.json | 2 +- .../gamesConfiguration.v1configuration.json | 2 +- .../gamesManagement.v1management.json | 2 +- .../discovery_cache/documents/gmail.v1.json | 2 +- .../documents/gmailpostmastertools.v1.json | 2 +- .../gmailpostmastertools.v1beta1.json | 2 +- .../documents/groupsmigration.v1.json | 2 +- .../documents/healthcare.v1.json | 2 +- .../documents/healthcare.v1beta1.json | 2 +- .../documents/homegraph.v1.json | 2 +- .../documents/iamcredentials.v1.json | 2 +- .../documents/indexing.v3.json | 2 +- .../documents/integrations.v1alpha.json | 14 +- .../documents/language.v1.json | 2 +- .../documents/language.v1beta2.json | 2 +- .../documents/language.v2.json | 2 +- .../documents/libraryagent.v1.json | 2 +- .../documents/licensing.v1.json | 2 +- .../documents/localservices.v1.json | 2 +- .../marketingplatformadmin.v1alpha.json | 2 +- .../documents/migrationcenter.v1alpha1.json | 2 +- .../mybusinessaccountmanagement.v1.json | 2 +- .../mybusinessbusinessinformation.v1.json | 2 +- .../documents/mybusinesslodging.v1.json | 2 +- .../documents/mybusinessnotifications.v1.json | 2 +- .../documents/mybusinessplaceactions.v1.json | 2 +- .../documents/mybusinessqanda.v1.json | 2 +- .../documents/mybusinessverifications.v1.json | 2 +- .../documents/osconfig.v1.json | 2 +- .../documents/osconfig.v1alpha.json | 2 +- .../documents/osconfig.v1beta.json | 2 +- .../discovery_cache/documents/oslogin.v1.json | 2 +- .../documents/pagespeedonline.v5.json | 2 +- .../paymentsresellersubscription.v1.json | 7 +- .../discovery_cache/documents/people.v1.json | 2 +- .../discovery_cache/documents/places.v1.json | 4 +- .../documents/playcustomapp.v1.json | 2 +- .../playdeveloperreporting.v1alpha1.json | 2 +- .../playdeveloperreporting.v1beta1.json | 2 +- .../documents/playgrouping.v1alpha1.json | 2 +- .../documents/playintegrity.v1.json | 2 +- .../documents/policysimulator.v1.json | 2 +- .../documents/policysimulator.v1alpha.json | 2 +- .../documents/policysimulator.v1beta.json | 2 +- .../documents/prod_tt_sasportal.v1alpha1.json | 2 +- .../documents/publicca.v1.json | 2 +- .../documents/publicca.v1alpha1.json | 2 +- .../documents/publicca.v1beta1.json | 2 +- .../documents/pubsublite.v1.json | 2 +- .../readerrevenuesubscriptionlinking.v1.json | 2 +- .../documents/realtimebidding.v1.json | 2 +- .../recommendationengine.v1beta1.json | 2 +- .../documents/reseller.v1.json | 2 +- .../documents/resourcesettings.v1.json | 2 +- .../documents/safebrowsing.v4.json | 2 +- .../documents/safebrowsing.v5.json | 2 +- .../documents/sasportal.v1alpha1.json | 2 +- .../discovery_cache/documents/script.v1.json | 2 +- .../documents/searchconsole.v1.json | 2 +- .../documents/servicenetworking.v1.json | 2 +- .../documents/servicenetworking.v1beta.json | 2 +- .../discovery_cache/documents/slides.v1.json | 2 +- .../discovery_cache/documents/solar.v1.json | 2 +- .../discovery_cache/documents/speech.v1.json | 2 +- .../documents/speech.v1p1beta1.json | 2 +- .../documents/sqladmin.v1.json | 2 +- .../documents/sqladmin.v1beta4.json | 2 +- .../discovery_cache/documents/storage.v1.json | 4 +- .../documents/streetviewpublish.v1.json | 2 +- .../documents/tagmanager.v1.json | 2 +- .../documents/tagmanager.v2.json | 2 +- .../discovery_cache/documents/tasks.v1.json | 2 +- .../discovery_cache/documents/testing.v1.json | 2 +- .../documents/toolresults.v1beta3.json | 2 +- .../documents/trafficdirector.v3.json | 27 +- .../documents/travelimpactmodel.v1.json | 2 +- .../discovery_cache/documents/vault.v1.json | 2 +- .../documents/verifiedaccess.v1.json | 2 +- .../documents/verifiedaccess.v2.json | 6 +- .../documents/versionhistory.v1.json | 2 +- .../documents/walletobjects.v1.json | 2 +- .../documents/webfonts.v1.json | 2 +- .../documents/workspaceevents.v1.json | 4 +- .../discovery_cache/documents/youtube.v3.json | 2 +- 303 files changed, 19854 insertions(+), 3834 deletions(-) create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.chat.html create mode 100644 docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html create mode 100644 docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.operations.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html create mode 100644 docs/dyn/dlp_v2.organizations.locations.connections.html create mode 100644 docs/dyn/dlp_v2.projects.locations.connections.html create mode 100644 docs/dyn/firebaseml_v2beta.html create mode 100644 docs/dyn/firebaseml_v2beta.projects.html create mode 100644 docs/dyn/firebaseml_v2beta.projects.locations.html create mode 100644 docs/dyn/firebaseml_v2beta.projects.locations.publishers.html create mode 100644 docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html create mode 100644 googleapiclient/discovery_cache/documents/firebaseml.v2beta.json diff --git a/docs/dyn/advisorynotifications_v1.organizations.locations.html b/docs/dyn/advisorynotifications_v1.organizations.locations.html index c648cdcd41b..8a255ef4ea3 100644 --- a/docs/dyn/advisorynotifications_v1.organizations.locations.html +++ b/docs/dyn/advisorynotifications_v1.organizations.locations.html @@ -99,7 +99,7 @@

Method Details

Get notification settings.
 
 Args:
-  name: string, Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings. (required)
+  name: string, Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -110,7 +110,7 @@ 

Method Details

{ # Settings for Advisory Notifications. "etag": "A String", # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle. - "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings. + "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. "notificationSettings": { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type. "a_key": { # Settings for each NotificationType. "enabled": True or False, # Whether the associated NotificationType is enabled. @@ -124,13 +124,13 @@

Method Details

Update notification settings.
 
 Args:
-  name: string, Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings. (required)
+  name: string, Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Settings for Advisory Notifications.
   "etag": "A String", # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
-  "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.
+  "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
   "notificationSettings": { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
     "a_key": { # Settings for each NotificationType.
       "enabled": True or False, # Whether the associated NotificationType is enabled.
@@ -148,7 +148,7 @@ 

Method Details

{ # Settings for Advisory Notifications. "etag": "A String", # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle. - "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings. + "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. "notificationSettings": { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type. "a_key": { # Settings for each NotificationType. "enabled": True or False, # Whether the associated NotificationType is enabled. diff --git a/docs/dyn/advisorynotifications_v1.organizations.locations.notifications.html b/docs/dyn/advisorynotifications_v1.organizations.locations.notifications.html index 5d36d562110..e28a19d768e 100644 --- a/docs/dyn/advisorynotifications_v1.organizations.locations.notifications.html +++ b/docs/dyn/advisorynotifications_v1.organizations.locations.notifications.html @@ -156,7 +156,7 @@

Method Details

Lists notifications under a given parent.
 
 Args:
-  parent: string, Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}" (required)
+  parent: string, Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}". (required)
   languageCode: string, ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
   pageSize: integer, The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
   pageToken: string, A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.
diff --git a/docs/dyn/advisorynotifications_v1.projects.locations.html b/docs/dyn/advisorynotifications_v1.projects.locations.html
index e5e496fd8aa..621fe7a366b 100644
--- a/docs/dyn/advisorynotifications_v1.projects.locations.html
+++ b/docs/dyn/advisorynotifications_v1.projects.locations.html
@@ -82,10 +82,79 @@ 

Instance Methods

close()

Close httplib2 connections.

+

+ getSettings(name, x__xgafv=None)

+

Get notification settings.

+

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

+

Update notification settings.

Method Details

close()
Close httplib2 connections.
+
+ getSettings(name, x__xgafv=None) +
Get notification settings.
+
+Args:
+  name: string, Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings for Advisory Notifications.
+  "etag": "A String", # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
+  "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
+  "notificationSettings": { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
+    "a_key": { # Settings for each NotificationType.
+      "enabled": True or False, # Whether the associated NotificationType is enabled.
+    },
+  },
+}
+
+ +
+ updateSettings(name, body=None, x__xgafv=None) +
Update notification settings.
+
+Args:
+  name: string, Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Settings for Advisory Notifications.
+  "etag": "A String", # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
+  "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
+  "notificationSettings": { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
+    "a_key": { # Settings for each NotificationType.
+      "enabled": True or False, # Whether the associated NotificationType is enabled.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Settings for Advisory Notifications.
+  "etag": "A String", # Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
+  "name": "A String", # Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
+  "notificationSettings": { # Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.
+    "a_key": { # Settings for each NotificationType.
+      "enabled": True or False, # Whether the associated NotificationType is enabled.
+    },
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/advisorynotifications_v1.projects.locations.notifications.html b/docs/dyn/advisorynotifications_v1.projects.locations.notifications.html index e557207f128..f6f9d3fd5ba 100644 --- a/docs/dyn/advisorynotifications_v1.projects.locations.notifications.html +++ b/docs/dyn/advisorynotifications_v1.projects.locations.notifications.html @@ -156,7 +156,7 @@

Method Details

Lists notifications under a given parent.
 
 Args:
-  parent: string, Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}" (required)
+  parent: string, Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}". (required)
   languageCode: string, ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.
   pageSize: integer, The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
   pageToken: string, A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 088b910955f..f5573198ea4 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -1098,6 +1098,7 @@ 

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -1269,9 +1270,6 @@

Method Details

}, }, ], - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. - "A String", - ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2589,6 +2587,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -2760,9 +2759,6 @@

Method Details

}, }, ], - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. - "A String", - ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index 44d2d5368b8..9c9df7d2c88 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -377,7 +377,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # LINT.IfChange The request message for MatchService.FindNeighbors. +{ # The request message for MatchService.FindNeighbors. "deployedIndexId": "A String", # The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request. "queries": [ # The list of queries. { # A query to find a number of the nearest neighbors (most similar vectors) of a vector. diff --git a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html index 154cd5e1ccb..6af3e0a394d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html @@ -163,25 +163,13 @@

Method Details

}, ], "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource. - "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - "a_key": "A String", - }, - "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" }, "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. - "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. - "imageUri": "A String", # 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. - "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. - "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. - }, - "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" } - "a_key": "A String", - }, }, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. @@ -313,25 +301,13 @@

Method Details

}, ], "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource. - "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - "a_key": "A String", - }, - "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" }, "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. - "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. - "imageUri": "A String", # 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. - "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. - "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. - }, - "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" } - "a_key": "A String", - }, }, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. @@ -404,25 +380,13 @@

Method Details

}, ], "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource. - "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - "a_key": "A String", - }, - "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" }, "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. - "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. - "imageUri": "A String", # 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. - "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. - "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. - }, - "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" } - "a_key": "A String", - }, }, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. @@ -501,25 +465,13 @@

Method Details

}, ], "resourceRuntime": { # Persistent Cluster runtime information as output # Output only. Runtime information of the Persistent Resource. - "accessUris": { # Output only. URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" } - "a_key": "A String", - }, - "notebookRuntimeTemplate": "A String", # Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123" }, "resourceRuntimeSpec": { # Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. # Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. "raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. - "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. - "imageUri": "A String", # 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. - "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. - "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. - }, - "resourcePoolImages": { # Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" } - "a_key": "A String", - }, }, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index fa69d5997a8..720ddbc3bb1 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -257,6 +257,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -428,9 +429,6 @@

Method Details

}, }, ], - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. - "A String", - ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -783,6 +781,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -954,9 +953,6 @@

Method Details

}, }, ], - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. - "A String", - ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 481ce416f99..56c4db6bc38 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -79,13 +79,634 @@

Instance Methods

Returns the operations Resource.

+

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

+

Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.

close()

Close httplib2 connections.

+

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

+

Creates a TuningJob. A created TuningJob right away will be attempted to be run.

+

+ get(name, x__xgafv=None)

+

Gets a TuningJob.

+

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

+

Lists TuningJobs in a Location.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.
+
+Args:
+  name: string, Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenAiTuningService.CancelTuningJob.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a TuningJob. A created TuningJob right away will be attempted to be run.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a TuningJob that runs with Google owned models.
+  "baseModel": "A String", # Model name for tuning, e.g., "gemini-1.0-pro-002".
+  "createTime": "A String", # Output only. Time when the TuningJob was created.
+  "description": "A String", # Optional. The description of the TuningJob.
+  "endTime": "A String", # Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+  "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+  "state": "A String", # Output only. The detailed state of the job.
+  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning. # Tuning Spec for Supervised Fine Tuning.
+    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+      "adapterSize": "A String", # Optional. Adapter size for tuning.
+      "epochCount": "A String", # Optional. Number of training epoches for this tuning job.
+      "learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for tuning.
+    },
+    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for tuning.
+    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning.
+  },
+  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. # Output only. The tuned model resources assiociated with this TuningJob.
+    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`.
+  },
+  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+    "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+      "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+      "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+      "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+      "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+      "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+        { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+          "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "fileData": { # URI based data. # Optional. URI based data.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+              },
+              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                "response": { # Required. The function response in JSON object format.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+                "data": "A String", # Required. Raw bytes.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "text": "A String", # Optional. Text part (can be code).
+              "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+        },
+      ],
+      "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+      "userMessagePerExampleDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the messages per example.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+      "userOutputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user output tokens.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a TuningJob that runs with Google owned models.
+  "baseModel": "A String", # Model name for tuning, e.g., "gemini-1.0-pro-002".
+  "createTime": "A String", # Output only. Time when the TuningJob was created.
+  "description": "A String", # Optional. The description of the TuningJob.
+  "endTime": "A String", # Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+  "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+  "state": "A String", # Output only. The detailed state of the job.
+  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning. # Tuning Spec for Supervised Fine Tuning.
+    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+      "adapterSize": "A String", # Optional. Adapter size for tuning.
+      "epochCount": "A String", # Optional. Number of training epoches for this tuning job.
+      "learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for tuning.
+    },
+    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for tuning.
+    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning.
+  },
+  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. # Output only. The tuned model resources assiociated with this TuningJob.
+    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`.
+  },
+  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+    "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+      "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+      "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+      "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+      "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+      "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+        { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+          "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "fileData": { # URI based data. # Optional. URI based data.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+              },
+              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                "response": { # Required. The function response in JSON object format.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+                "data": "A String", # Required. Raw bytes.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "text": "A String", # Optional. Text part (can be code).
+              "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+        },
+      ],
+      "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+      "userMessagePerExampleDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the messages per example.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+      "userOutputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user output tokens.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a TuningJob.
+
+Args:
+  name: string, Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a TuningJob that runs with Google owned models.
+  "baseModel": "A String", # Model name for tuning, e.g., "gemini-1.0-pro-002".
+  "createTime": "A String", # Output only. Time when the TuningJob was created.
+  "description": "A String", # Optional. The description of the TuningJob.
+  "endTime": "A String", # Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+  "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+  "state": "A String", # Output only. The detailed state of the job.
+  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning. # Tuning Spec for Supervised Fine Tuning.
+    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+      "adapterSize": "A String", # Optional. Adapter size for tuning.
+      "epochCount": "A String", # Optional. Number of training epoches for this tuning job.
+      "learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for tuning.
+    },
+    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for tuning.
+    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning.
+  },
+  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. # Output only. The tuned model resources assiociated with this TuningJob.
+    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`.
+  },
+  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+    "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+      "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+      "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+      "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+      "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+      "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+        { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+          "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "fileData": { # URI based data. # Optional. URI based data.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                  "a_key": "", # Properties of the object.
+                },
+                "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+              },
+              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                "response": { # Required. The function response in JSON object format.
+                  "a_key": "", # Properties of the object.
+                },
+              },
+              "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+                "data": "A String", # Required. Raw bytes.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "text": "A String", # Optional. Text part (can be code).
+              "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                "endOffset": "A String", # Optional. The end offset of the video.
+                "startOffset": "A String", # Optional. The start offset of the video.
+              },
+            },
+          ],
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+        },
+      ],
+      "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+      "userMessagePerExampleDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the messages per example.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+      "userOutputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user output tokens.
+        "buckets": [ # Output only. Defines the histogram bucket.
+          { # Dataset bucket used to create a histogram for the distribution given a population of values.
+            "count": 3.14, # Output only. Number of values in the bucket.
+            "left": 3.14, # Output only. Left bound of the bucket.
+            "right": 3.14, # Output only. Right bound of the bucket.
+          },
+        ],
+        "max": 3.14, # Output only. The maximum of the population values.
+        "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+        "median": 3.14, # Output only. The median of the values in the population.
+        "min": 3.14, # Output only. The minimum of the population values.
+        "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+        "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+        "sum": "A String", # Output only. Sum of a given population of values.
+      },
+    },
+  },
+  "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists TuningJobs in a Location.
+
+Args:
+  parent: string, Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. The standard list filter.
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token. Typically obtained via ListTuningJob.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for GenAiTuningService.ListTuningJobs
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page.
+  "tuningJobs": [ # List of TuningJobs in the requested page.
+    { # Represents a TuningJob that runs with Google owned models.
+      "baseModel": "A String", # Model name for tuning, e.g., "gemini-1.0-pro-002".
+      "createTime": "A String", # Output only. Time when the TuningJob was created.
+      "description": "A String", # Optional. The description of the TuningJob.
+      "endTime": "A String", # Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "experiment": "A String", # Output only. The Experiment associated with this TuningJob.
+      "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`
+      "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+      "state": "A String", # Output only. The detailed state of the job.
+      "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning. # Tuning Spec for Supervised Fine Tuning.
+        "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+          "adapterSize": "A String", # Optional. Adapter size for tuning.
+          "epochCount": "A String", # Optional. Number of training epoches for this tuning job.
+          "learningRateMultiplier": 3.14, # Optional. Learning rate multiplier for tuning.
+        },
+        "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for tuning.
+        "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning.
+      },
+      "tunedModel": { # The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob. # Output only. The tuned model resources assiociated with this TuningJob.
+        "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+        "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`.
+      },
+      "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+      "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+        "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats.
+          "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+          "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+          "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+          "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+          "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+            { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "fileData": { # URI based data. # Optional. URI based data.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                      "a_key": "", # Properties of the object.
+                    },
+                    "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+                  },
+                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "response": { # Required. The function response in JSON object format.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+                    "data": "A String", # Required. Raw bytes.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "text": "A String", # Optional. Text part (can be code).
+                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "endOffset": "A String", # Optional. The end offset of the video.
+                    "startOffset": "A String", # Optional. The start offset of the video.
+                  },
+                },
+              ],
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+            },
+          ],
+          "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
+            "buckets": [ # Output only. Defines the histogram bucket.
+              { # Dataset bucket used to create a histogram for the distribution given a population of values.
+                "count": 3.14, # Output only. Number of values in the bucket.
+                "left": 3.14, # Output only. Left bound of the bucket.
+                "right": 3.14, # Output only. Right bound of the bucket.
+              },
+            ],
+            "max": 3.14, # Output only. The maximum of the population values.
+            "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+            "median": 3.14, # Output only. The median of the values in the population.
+            "min": 3.14, # Output only. The minimum of the population values.
+            "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+            "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+            "sum": "A String", # Output only. Sum of a given population of values.
+          },
+          "userMessagePerExampleDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the messages per example.
+            "buckets": [ # Output only. Defines the histogram bucket.
+              { # Dataset bucket used to create a histogram for the distribution given a population of values.
+                "count": 3.14, # Output only. Number of values in the bucket.
+                "left": 3.14, # Output only. Left bound of the bucket.
+                "right": 3.14, # Output only. Right bound of the bucket.
+              },
+            ],
+            "max": 3.14, # Output only. The maximum of the population values.
+            "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+            "median": 3.14, # Output only. The median of the values in the population.
+            "min": 3.14, # Output only. The minimum of the population values.
+            "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+            "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+            "sum": "A String", # Output only. Sum of a given population of values.
+          },
+          "userOutputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user output tokens.
+            "buckets": [ # Output only. Defines the histogram bucket.
+              { # Dataset bucket used to create a histogram for the distribution given a population of values.
+                "count": 3.14, # Output only. Number of values in the bucket.
+                "left": 3.14, # Output only. Left bound of the bucket.
+                "right": 3.14, # Output only. Right bound of the bucket.
+              },
+            ],
+            "max": 3.14, # Output only. The maximum of the population values.
+            "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+            "median": 3.14, # Output only. The median of the values in the population.
+            "min": 3.14, # Output only. The minimum of the population values.
+            "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+            "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+            "sum": "A String", # Output only. Sum of a given population of values.
+          },
+        },
+      },
+      "updateTime": "A String", # Output only. Time when the TuningJob was most recently updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 092ffda7e9d..7727c7007ee 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -217,87 +217,6 @@

Method Details

"A String", ], }, - "multiDeployVertex": { # Multiple setups to deploy the PublisherModel. # Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. - "multiDeployVertex": [ # Optional. One click deployment configurations. - { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. - "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. - "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. - }, - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. - "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - "A String", - ], - "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - "A String", - ], - "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours. - "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - { # Represents an environment variable present in a Container or Python Module. - "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier. - "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. - }, - ], - "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API. - { # Represents a network port in a container. - "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. - }, - ], - "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe. - "exec": { # ExecAction specifies a command to execute. # Exec specifies the action to take. - "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - "A String", - ], - }, - "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. - "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - }, - "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field. - "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - { # Represents a network port in a container. - "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. - }, - ], - "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes. - "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe. - "exec": { # ExecAction specifies a command to execute. # Exec specifies the action to take. - "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - "A String", - ], - }, - "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. - "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - }, - }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. - "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. - { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` - "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. - }, - ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. - "acceleratorCount": 42, # The number of accelerators to attach to the machine. - "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. - "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). - }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - }, - "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed. - "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc. - }, - "modelDisplayName": "A String", # Optional. Default model display name. - "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact. - "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - "title": "A String", # Required. The title of the regional resource reference. - }, - ], - }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index 554ada442ab..909495b3453 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -74,11 +74,6 @@

Vertex AI API

Instance Methods

-

- media() -

-

Returns the media Resource.

-

projects()

diff --git a/docs/dyn/aiplatform_v1beta1.projects.html b/docs/dyn/aiplatform_v1beta1.projects.html index cd9c137c0e9..1ac1a359874 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.html +++ b/docs/dyn/aiplatform_v1beta1.projects.html @@ -82,10 +82,79 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getCacheConfig(name, x__xgafv=None)

+

Gets a GenAI cache config.

+

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

+

Updates a cache config.

Method Details

close()
Close httplib2 connections.
+
+ getCacheConfig(name, x__xgafv=None) +
Gets a GenAI cache config.
+
+Args:
+  name: string, Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Config of GenAI caching features. This is a singleton resource.
+  "disableCache": True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled.
+  "name": "A String", # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.
+}
+
+ +
+ updateCacheConfig(name, body=None, x__xgafv=None) +
Updates a cache config.
+
+Args:
+  name: string, Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Config of GenAI caching features. This is a singleton resource.
+  "disableCache": True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled.
+  "name": "A String", # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, 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`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.chat.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.chat.html new file mode 100644 index 00000000000..2eb96bc1540 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.chat.html @@ -0,0 +1,127 @@ + + + +

Vertex AI API . projects . locations . endpoints . chat

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ completions(endpoint, body=None, x__xgafv=None)

+

Exposes an OpenAI-compatible endpoint for chat completions.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ completions(endpoint, body=None, x__xgafv=None) +
Exposes an OpenAI-compatible endpoint for chat completions.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # 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.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index ba87dd36b17..1460313fe58 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -74,6 +74,11 @@

Vertex AI API . projects . locations . endpoints

Instance Methods

+

+ chat() +

+

Returns the chat Resource.

+

operations()

@@ -1242,6 +1247,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -2896,6 +2902,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 7a37d7958b9..c4f9f112897 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -322,6 +322,21 @@

Method Details

"name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long. }, "name": "A String", # Identifier. The resource name of the Extension. + "privateServiceConnectConfig": { # PrivateExtensionConfig configuration for the extension. # Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution. + "serviceDirectory": "A String", # Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. + }, + "runtimeConfig": { # Runtime configuration to run the extension. # Optional. Runtime config controlling the runtime behavior of this Extension. + "codeInterpreterRuntimeConfig": { # Code execution runtime configurations for code interpreter extension. + "fileInputGcsBucket": "A String", # Optional. The GCS bucket for file input of this Extension. If specified, support input from the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject GCS file inputs. + "fileOutputGcsBucket": "A String", # Optional. The GCS bucket for file output of this Extension. If specified, write all output files to the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body. + }, + "defaultParams": { # Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}. + "a_key": "", # Properties of the object. + }, + "vertexAiSearchRuntimeConfig": { # Runtime configuration for Vertext AI Search extension. + "servingConfigName": "A String", # Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}` + }, + }, "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool. { # A single example of the tool usage. "displayName": "A String", # Required. The display name for example. @@ -456,6 +471,21 @@

Method Details

"name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long. }, "name": "A String", # Identifier. The resource name of the Extension. + "privateServiceConnectConfig": { # PrivateExtensionConfig configuration for the extension. # Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution. + "serviceDirectory": "A String", # Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. + }, + "runtimeConfig": { # Runtime configuration to run the extension. # Optional. Runtime config controlling the runtime behavior of this Extension. + "codeInterpreterRuntimeConfig": { # Code execution runtime configurations for code interpreter extension. + "fileInputGcsBucket": "A String", # Optional. The GCS bucket for file input of this Extension. If specified, support input from the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject GCS file inputs. + "fileOutputGcsBucket": "A String", # Optional. The GCS bucket for file output of this Extension. If specified, write all output files to the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body. + }, + "defaultParams": { # Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}. + "a_key": "", # Properties of the object. + }, + "vertexAiSearchRuntimeConfig": { # Runtime configuration for Vertext AI Search extension. + "servingConfigName": "A String", # Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}` + }, + }, "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool. { # A single example of the tool usage. "displayName": "A String", # Required. The display name for example. @@ -629,6 +659,21 @@

Method Details

"name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long. }, "name": "A String", # Identifier. The resource name of the Extension. + "privateServiceConnectConfig": { # PrivateExtensionConfig configuration for the extension. # Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution. + "serviceDirectory": "A String", # Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. + }, + "runtimeConfig": { # Runtime configuration to run the extension. # Optional. Runtime config controlling the runtime behavior of this Extension. + "codeInterpreterRuntimeConfig": { # Code execution runtime configurations for code interpreter extension. + "fileInputGcsBucket": "A String", # Optional. The GCS bucket for file input of this Extension. If specified, support input from the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject GCS file inputs. + "fileOutputGcsBucket": "A String", # Optional. The GCS bucket for file output of this Extension. If specified, write all output files to the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body. + }, + "defaultParams": { # Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}. + "a_key": "", # Properties of the object. + }, + "vertexAiSearchRuntimeConfig": { # Runtime configuration for Vertext AI Search extension. + "servingConfigName": "A String", # Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}` + }, + }, "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool. { # A single example of the tool usage. "displayName": "A String", # Required. The display name for example. @@ -780,6 +825,21 @@

Method Details

"name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long. }, "name": "A String", # Identifier. The resource name of the Extension. + "privateServiceConnectConfig": { # PrivateExtensionConfig configuration for the extension. # Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution. + "serviceDirectory": "A String", # Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. + }, + "runtimeConfig": { # Runtime configuration to run the extension. # Optional. Runtime config controlling the runtime behavior of this Extension. + "codeInterpreterRuntimeConfig": { # Code execution runtime configurations for code interpreter extension. + "fileInputGcsBucket": "A String", # Optional. The GCS bucket for file input of this Extension. If specified, support input from the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject GCS file inputs. + "fileOutputGcsBucket": "A String", # Optional. The GCS bucket for file output of this Extension. If specified, write all output files to the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body. + }, + "defaultParams": { # Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}. + "a_key": "", # Properties of the object. + }, + "vertexAiSearchRuntimeConfig": { # Runtime configuration for Vertext AI Search extension. + "servingConfigName": "A String", # Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}` + }, + }, "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool. { # A single example of the tool usage. "displayName": "A String", # Required. The display name for example. @@ -913,6 +973,21 @@

Method Details

"name": "A String", # Required. Extension name shown to the LLM. The name can be up to 128 characters long. }, "name": "A String", # Identifier. The resource name of the Extension. + "privateServiceConnectConfig": { # PrivateExtensionConfig configuration for the extension. # Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution. + "serviceDirectory": "A String", # Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource. + }, + "runtimeConfig": { # Runtime configuration to run the extension. # Optional. Runtime config controlling the runtime behavior of this Extension. + "codeInterpreterRuntimeConfig": { # Code execution runtime configurations for code interpreter extension. + "fileInputGcsBucket": "A String", # Optional. The GCS bucket for file input of this Extension. If specified, support input from the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject GCS file inputs. + "fileOutputGcsBucket": "A String", # Optional. The GCS bucket for file output of this Extension. If specified, write all output files to the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body. + }, + "defaultParams": { # Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}. + "a_key": "", # Properties of the object. + }, + "vertexAiSearchRuntimeConfig": { # Runtime configuration for Vertext AI Search extension. + "servingConfigName": "A String", # Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}` + }, + }, "toolUseExamples": [ # Optional. Examples to illustrate the usage of the extension as a tool. { # A single example of the tool usage. "displayName": "A String", # Required. The display name for example. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 44de52670c1..339ce7aa5e8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -279,9 +279,6 @@

Instance Methods

list_next()

Retrieves the next page of results.

-

- retrieveContexts(parent, body=None, x__xgafv=None)

-

Retrieves relevant contexts for a query.

Method Details

close() @@ -355,7 +352,7 @@

Method Details

"pairwiseQuestionAnsweringQualityInput": { # Input for pairwise question answering quality metric. # Input for pairwise question answering quality metric. "instance": { # Spec for pairwise question answering quality instance. # Required. Pairwise question answering quality instance. "baselinePrediction": "A String", # Required. Output of the baseline model. - "context": "A String", # Optional. Text to answer the question. + "context": "A String", # Required. Text to answer the question. "instruction": "A String", # Required. Question Answering prompt for LLM. "prediction": "A String", # Required. Output of the candidate model. "reference": "A String", # Optional. Ground truth used to compare against the prediction. @@ -404,7 +401,7 @@

Method Details

}, "questionAnsweringQualityInput": { # Input for question answering quality metric. # Input for question answering quality metric. "instance": { # Spec for question answering quality instance. # Required. Question answering quality instance. - "context": "A String", # Optional. Text to answer the question. + "context": "A String", # Required. Text to answer the question. "instruction": "A String", # Required. Question Answering prompt for LLM. "prediction": "A String", # Required. Output of the evaluated model. "reference": "A String", # Optional. Ground truth used to compare against the prediction. @@ -426,24 +423,6 @@

Method Details

"version": 42, # Optional. Which version to use for evaluation. }, }, - "ragContextRecallInput": { # Input for rag context recall metric. # Input for rag context recall metric. - "instance": { # Spec for rag context recall instance. # Required. Rag context recall instance. - "context": "A String", # Required. Retrieved facts from RAG pipeline as context to be evaluated. - "reference": "A String", # Required. Ground truth used to compare against the context. - }, - "metricSpec": { # Spec for rag context recall metric. # Required. Spec for rag context recall metric. - "version": 42, # Optional. Which version to use for evaluation. - }, - }, - "responseRecallInput": { # Input for response recall metric. # Input for response recall metric. - "instance": { # Spec for response recall instance. # Required. Response recall instance. - "prediction": "A String", # Required. Output of the evaluated model. - "reference": "A String", # Required. Ground truth used to compare against the prediction. - }, - "metricSpec": { # Spec for response recall metric. # Required. Spec for response recall score metric. - "version": 42, # Optional. Which version to use for evaluation. - }, - }, "rougeInput": { # Input for rouge metric. # Instances and metric spec for rouge metric. "instances": [ # Required. Repeated rouge instances. { # Spec for rouge instance. @@ -617,16 +596,6 @@

Method Details

"explanation": "A String", # Output only. Explanation for question answering relevance score. "score": 3.14, # Output only. Question Answering Relevance score. }, - "ragContextRecallResult": { # Spec for rag context recall result. # RAG only metrics. Result for context recall metric. - "confidence": 3.14, # Output only. Confidence for rag context recall score. - "explanation": "A String", # Output only. Explanation for rag context recall score. - "score": 3.14, # Output only. RagContextRecall score. - }, - "responseRecallResult": { # Spec for response recall result. # Result for response recall metric. - "confidence": 3.14, # Output only. Confidence for fulfillment score. - "explanation": "A String", # Output only. Explanation for response recall score. - "score": 3.14, # Output only. ResponseRecall score. - }, "rougeResults": { # Results for rouge metric. # Results for rouge metric. "rougeMetricValues": [ # Output only. Rouge metric values. { # Rouge metric value for an instance. @@ -761,46 +730,4 @@

Method Details

-
- retrieveContexts(parent, body=None, x__xgafv=None) -
Retrieves relevant contexts for a query.
-
-Args:
-  parent: string, Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for VertexRagService.RetrieveContexts.
-  "query": { # A query to retrieve relevant contexts. # Required. Single RAG retrieve query.
-    "similarityTopK": 42, # Optional. The number of contexts to retrieve.
-    "text": "A String", # Optional. The query in text format to get relevant contexts.
-  },
-  "vertexRagStore": { # The data source for Vertex RagStore. # The data source for Vertex RagStore.
-    "ragCorpora": [ # Required. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.
-      "A String",
-    ],
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for VertexRagService.RetrieveContexts.
-  "contexts": { # Relevant contexts for one query. # The contexts of the query.
-    "contexts": [ # All its contexts.
-      { # A context of the query.
-        "distance": 3.14, # The distance between the query vector and the context text vector.
-        "sourceUri": "A String", # For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
-        "text": "A String", # The text chunk.
-      },
-    ],
-  },
-}
-
- \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index b6a4a3a883a..0dbb1c6d114 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -377,7 +377,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # LINT.IfChange The request message for MatchService.FindNeighbors. +{ # The request message for MatchService.FindNeighbors. "deployedIndexId": "A String", # The ID of the DeployedIndex that will serve the request. This request is sent to a specific IndexEndpoint, as per the IndexEndpoint.network. That IndexEndpoint also has IndexEndpoint.deployed_indexes, and each such index has a DeployedIndex.id field. The value of the field below must equal one of the DeployedIndex.id fields of the IndexEndpoint that is being called for this request. "queries": [ # The list of queries. { # A query to find a number of the nearest neighbors (most similar vectors) of a vector. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html index 3238f16a9d5..7ac213a260b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html @@ -181,7 +181,7 @@

Method Details

}, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. @@ -331,7 +331,7 @@

Method Details

}, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. @@ -422,7 +422,7 @@

Method Details

}, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. @@ -519,7 +519,7 @@

Method Details

}, "serviceAccountSpec": { # Configuration for the use of custom service account to run the workloads. # Optional. Configure the use of workload identity on the PersistentResource "enableCustomServiceAccount": True or False, # Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). - "serviceAccount": "A String", # Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. + "serviceAccount": "A String", # Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job. }, }, "startTime": "A String", # Output only. Time when the PersistentResource for the first time entered the `RUNNING` state. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index a938dde9603..bae4b626300 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -257,6 +257,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -864,6 +865,7 @@

Method Details

"frequencyPenalty": 3.14, # Optional. Frequency penalties. "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. "presencePenalty": 3.14, # Optional. Positive penalties. + "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. "stopSequences": [ # Optional. Stop sequences. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html index e255cbab287..98616af8adc 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html @@ -87,174 +87,10 @@

Instance Methods

close()

Close httplib2 connections.

-

- create(parent, body=None, x__xgafv=None)

-

Creates a RagCorpus.

-

- delete(name, force=None, x__xgafv=None)

-

Deletes a RagCorpus.

-

- get(name, x__xgafv=None)

-

Gets a RagCorpus.

-

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

-

Lists RagCorpora in a Location.

-

- list_next()

-

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
-
- create(parent, body=None, x__xgafv=None) -
Creates a RagCorpus.
-
-Args:
-  parent: string, Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
-  "createTime": "A String", # Output only. Timestamp when this RagCorpus was created.
-  "description": "A String", # Optional. The description of the RagCorpus.
-  "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-  "name": "A String", # Output only. The resource name of the RagCorpus.
-  "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, 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`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- delete(name, force=None, x__xgafv=None) -
Deletes a RagCorpus.
-
-Args:
-  name: string, Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
-  force: boolean, Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, 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`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Gets a RagCorpus.
-
-Args:
-  name: string, Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
-  "createTime": "A String", # Output only. Timestamp when this RagCorpus was created.
-  "description": "A String", # Optional. The description of the RagCorpus.
-  "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-  "name": "A String", # Output only. The resource name of the RagCorpus.
-  "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
-}
-
- -
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists RagCorpora in a Location.
-
-Args:
-  parent: string, Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}` (required)
-  pageSize: integer, Optional. The standard list page size.
-  pageToken: string, Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for VertexRagDataService.ListRagCorpora.
-  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.
-  "ragCorpora": [ # List of RagCorpora in the requested page.
-    { # A RagCorpus is a RagFile container and a project can have multiple RagCorpora.
-      "createTime": "A String", # Output only. Timestamp when this RagCorpus was created.
-      "description": "A String", # Optional. The description of the RagCorpus.
-      "displayName": "A String", # Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-      "name": "A String", # Output only. The resource name of the RagCorpus.
-      "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
-    },
-  ],
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index ff8322bde4c..91817d8cb9e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -82,221 +82,10 @@

Instance Methods

close()

Close httplib2 connections.

-

- delete(name, x__xgafv=None)

-

Deletes a RagFile.

-

- get(name, x__xgafv=None)

-

Gets a RagFile.

-

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

-

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

-

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

-

Lists RagFiles in a RagCorpus.

-

- list_next()

-

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
-
- delete(name, x__xgafv=None) -
Deletes a RagFile.
-
-Args:
-  name: string, Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, 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`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Gets a RagFile.
-
-Args:
-  name: string, Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A RagFile contains user data for chunking, embedding and indexing.
-  "createTime": "A String", # Output only. Timestamp when this RagFile was created.
-  "description": "A String", # Optional. The description of the RagFile.
-  "directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
-  },
-  "displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-  "gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the GCS uri for now.
-    "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
-      "A String",
-    ],
-  },
-  "googleDriveSource": { # The Google Drive location for the input content. # Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
-    "resourceIds": [ # Required. Google Drive resource IDs.
-      { # The type and ID of the Google Drive resource.
-        "resourceId": "A String", # Required. The ID of the Google Drive resource.
-        "resourceType": "A String", # Required. The type of the Google Drive resource.
-      },
-    ],
-  },
-  "name": "A String", # Output only. The resource name of the RagFile.
-  "ragFileType": "A String", # Output only. The type of the RagFile.
-  "sizeBytes": "A String", # Output only. The size of the RagFile in bytes.
-  "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
-}
-
- -
- import_(parent, body=None, x__xgafv=None) -
Import files from Google Cloud Storage or Google Drive into a RagCorpus.
-
-Args:
-  parent: string, Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for VertexRagDataService.ImportRagFiles.
-  "importRagFilesConfig": { # Config for importing RagFiles. # Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles.
-    "gcsSource": { # The Google Cloud Storage location for the input content. # Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: * "gs://bucket_name/my_directory/object_name/my_file.txt". * "gs://bucket_name/my_directory"
-      "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
-        "A String",
-      ],
-    },
-    "googleDriveSource": { # The Google Drive location for the input content. # Google Drive location. Supports importing individual files as well as Google Drive folders.
-      "resourceIds": [ # Required. Google Drive resource IDs.
-        { # The type and ID of the Google Drive resource.
-          "resourceId": "A String", # Required. The ID of the Google Drive resource.
-          "resourceType": "A String", # Required. The type of the Google Drive resource.
-        },
-      ],
-    },
-    "ragFileChunkingConfig": { # Specifies the size and overlap of chunks for RagFiles. # Specifies the size and overlap of chunks after importing RagFiles.
-      "chunkOverlap": 42, # The overlap between chunks.
-      "chunkSize": 42, # The size of the chunks.
-    },
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, 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`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists RagFiles in a RagCorpus.
-
-Args:
-  parent: string, Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
-  pageSize: integer, Optional. The standard list page size.
-  pageToken: string, Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for VertexRagDataService.ListRagFiles.
-  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.
-  "ragFiles": [ # List of RagFiles in the requested page.
-    { # A RagFile contains user data for chunking, embedding and indexing.
-      "createTime": "A String", # Output only. Timestamp when this RagFile was created.
-      "description": "A String", # Optional. The description of the RagFile.
-      "directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
-      },
-      "displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-      "gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the GCS uri for now.
-        "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/gsutil/addlhelp/WildcardNames.
-          "A String",
-        ],
-      },
-      "googleDriveSource": { # The Google Drive location for the input content. # Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
-        "resourceIds": [ # Required. Google Drive resource IDs.
-          { # The type and ID of the Google Drive resource.
-            "resourceId": "A String", # Required. The ID of the Google Drive resource.
-            "resourceType": "A String", # Required. The type of the Google Drive resource.
-          },
-        ],
-      },
-      "name": "A String", # Output only. The resource name of the RagFile.
-      "ragFileType": "A String", # Output only. The type of the RagFile.
-      "sizeBytes": "A String", # Output only. The size of the RagFile in bytes.
-      "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
-    },
-  ],
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 85e0c78bd1d..a5233c4bd2e 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -232,87 +232,6 @@

Method Details

"A String", ], }, - "multiDeployVertex": { # Multiple setups to deploy the PublisherModel. # Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. - "multiDeployVertex": [ # Optional. One click deployment configurations. - { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. - "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. - "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. - }, - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. - "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - "A String", - ], - "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - "A String", - ], - "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours. - "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - { # Represents an environment variable present in a Container or Python Module. - "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier. - "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. - }, - ], - "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API. - { # Represents a network port in a container. - "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. - }, - ], - "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe. - "exec": { # ExecAction specifies a command to execute. # Exec specifies the action to take. - "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - "A String", - ], - }, - "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. - "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - }, - "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field. - "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - { # Represents a network port in a container. - "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. - }, - ], - "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes. - "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe. - "exec": { # ExecAction specifies a command to execute. # Exec specifies the action to take. - "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - "A String", - ], - }, - "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. - "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - }, - }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. - "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. - { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` - "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. - }, - ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. - "acceleratorCount": 42, # The number of accelerators to attach to the machine. - "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. - "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). - }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - }, - "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed. - "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc. - }, - "modelDisplayName": "A String", # Optional. Default model display name. - "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact. - "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - "title": "A String", # Required. The title of the regional resource reference. - }, - ], - }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. @@ -609,87 +528,6 @@

Method Details

"A String", ], }, - "multiDeployVertex": { # Multiple setups to deploy the PublisherModel. # Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint. - "multiDeployVertex": [ # Optional. One click deployment configurations. - { # Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests. - "artifactUri": "A String", # Optional. The path to the directory containing the Model artifact and any of its supporting files. - "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. - "minReplicaCount": 42, # Immutable. The minimum number of replicas this DeployedModel will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. - }, - "containerSpec": { # Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). # Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models. - "args": [ # Immutable. Specifies arguments for the command that runs when the container starts. This overrides the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd). Specify this field as an array of executable and arguments, similar to a Docker `CMD`'s "default parameters" form. If you don't specify this field but do specify the command field, then the command from the `command` field runs without any additional arguments. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). If you don't specify this field and don't specify the `command` field, then the container's [`ENTRYPOINT`](https://docs.docker.com/engine/reference/builder/#cmd) and `CMD` determine what runs based on their default behavior. See the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `args` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - "A String", - ], - "command": [ # Immutable. Specifies the command that runs when the container starts. This overrides the container's [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint). Specify this field as an array of executable and arguments, similar to a Docker `ENTRYPOINT`'s "exec" form, not its "shell" form. If you do not specify this field, then the container's `ENTRYPOINT` runs, in conjunction with the args field or the container's [`CMD`](https://docs.docker.com/engine/reference/builder/#cmd), if either exists. If this field is not specified and the container does not have an `ENTRYPOINT`, then refer to the Docker documentation about [how `CMD` and `ENTRYPOINT` interact](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact). If you specify this field, then you can also specify the `args` field to provide additional arguments for this command. However, if you specify this field, then the container's `CMD` is ignored. See the [Kubernetes documentation about how the `command` and `args` fields interact with a container's `ENTRYPOINT` and `CMD`](https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#notes). In this field, you can reference [environment variables set by Vertex AI](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables) and environment variables set in the env field. You cannot reference environment variables set in the Docker image. In order for environment variables to be expanded, reference them by using the following syntax: $( VARIABLE_NAME) Note that this differs from Bash variable expansion, which does not use parentheses. If a variable cannot be resolved, the reference in the input string is used unchanged. To avoid variable expansion, you can escape this syntax with `$$`; for example: $$(VARIABLE_NAME) This field corresponds to the `command` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - "A String", - ], - "deploymentTimeout": "A String", # Immutable. Deployment timeout. Limit for deployment timeout is 2 hours. - "env": [ # Immutable. List of environment variables to set in the container. After the container starts running, code running in the container can read these environment variables. Additionally, the command and args fields can reference these variables. Later entries in this list can also reference earlier entries. For example, the following example sets the variable `VAR_2` to have the value `foo bar`: ```json [ { "name": "VAR_1", "value": "foo" }, { "name": "VAR_2", "value": "$(VAR_1) bar" } ] ``` If you switch the order of the variables in the example, then the expansion does not occur. This field corresponds to the `env` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - { # Represents an environment variable present in a Container or Python Module. - "name": "A String", # Required. Name of the environment variable. Must be a valid C identifier. - "value": "A String", # Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. - }, - ], - "grpcPorts": [ # Immutable. List of ports to expose from the container. Vertex AI sends gRPC prediction requests that it receives to the first port on this list. Vertex AI also sends liveness and health checks to this port. If you do not specify this field, gRPC requests to the container will be disabled. Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers v1 core API. - { # Represents a network port in a container. - "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. - }, - ], - "healthProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes readiness probe. - "exec": { # ExecAction specifies a command to execute. # Exec specifies the action to take. - "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - "A String", - ], - }, - "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. - "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - }, - "healthRoute": "A String", # Immutable. HTTP path on the container to send health checks to. Vertex AI intermittently sends GET requests to this path on the container's IP address and port to check that the container is healthy. Read more about [health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#health). For example, if you set this field to `/bar`, then Vertex AI intermittently sends a GET request to the `/bar` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/ DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - "imageUri": "A String", # Required. Immutable. URI of the Docker image to be used as the custom container for serving predictions. This URI must identify an image in Artifact Registry or Container Registry. Learn more about the [container publishing requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#publishing), including permissions requirements for the Vertex AI Service Agent. The container image is ingested upon ModelService.UploadModel, stored internally, and this original path is afterwards not used. To learn about the requirements for the Docker image itself, see [Custom container requirements](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#). You can use the URI to one of Vertex AI's [pre-built container images for prediction](https://cloud.google.com/vertex-ai/docs/predictions/pre-built-containers) in this field. - "ports": [ # Immutable. List of ports to expose from the container. Vertex AI sends any prediction requests that it receives to the first port on this list. Vertex AI also sends [liveness and health checks](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#liveness) to this port. If you do not specify this field, it defaults to following value: ```json [ { "containerPort": 8080 } ] ``` Vertex AI does not use ports other than the first one listed. This field corresponds to the `ports` field of the Kubernetes Containers [v1 core API](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). - { # Represents a network port in a container. - "containerPort": 42, # The number of the port to expose on the pod's IP address. Must be a valid port number, between 1 and 65535 inclusive. - }, - ], - "predictRoute": "A String", # Immutable. HTTP path on the container to send prediction requests to. Vertex AI forwards requests sent using projects.locations.endpoints.predict to this path on the container's IP address and port. Vertex AI then returns the container's response in the API response. For example, if you set this field to `/foo`, then when Vertex AI receives a prediction request, it forwards the request body in a POST request to the `/foo` path on the port of your container specified by the first value of this `ModelContainerSpec`'s ports field. If you don't specify this field, it defaults to the following value when you deploy this Model to an Endpoint: /v1/endpoints/ENDPOINT/deployedModels/DEPLOYED_MODEL:predict The placeholders in this value are replaced as follows: * ENDPOINT: The last segment (following `endpoints/`)of the Endpoint.name][] field of the Endpoint where this Model has been deployed. (Vertex AI makes this value available to your container code as the [`AIP_ENDPOINT_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) * DEPLOYED_MODEL: DeployedModel.id of the `DeployedModel`. (Vertex AI makes this value available to your container code as the [`AIP_DEPLOYED_MODEL_ID` environment variable](https://cloud.google.com/vertex-ai/docs/predictions/custom-container-requirements#aip-variables).) - "sharedMemorySizeMb": "A String", # Immutable. The amount of the VM memory to reserve as the shared memory for the model in megabytes. - "startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Immutable. Specification for Kubernetes startup probe. - "exec": { # ExecAction specifies a command to execute. # Exec specifies the action to take. - "command": [ # Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - "A String", - ], - }, - "periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds. Maps to Kubernetes probe argument 'periodSeconds'. - "timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds. Maps to Kubernetes probe argument 'timeoutSeconds'. - }, - }, - "dedicatedResources": { # A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. # A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. - "autoscalingMetricSpecs": [ # Immutable. The metric specifications that overrides a resource utilization metric (CPU utilization, accelerator's duty cycle, and so on) target value (default to 60 if not set). At most one entry is allowed per metric. If machine_spec.accelerator_count is above 0, the autoscaling will be based on both CPU utilization and accelerator's duty cycle metrics and scale up when either metrics exceeds its target value while scale down if both metrics are under their target value. The default target value is 60 for both metrics. If machine_spec.accelerator_count is 0, the autoscaling will be based on CPU utilization metric only with default target value 60 if not explicitly set. For example, in the case of Online Prediction, if you want to override target CPU utilization to 80, you should set autoscaling_metric_specs.metric_name to `aiplatform.googleapis.com/prediction/online/cpu/utilization` and autoscaling_metric_specs.target to `80`. - { # The metric specification that defines the target resource utilization (CPU utilization, accelerator's duty cycle, and so on) for calculating the desired replica count. - "metricName": "A String", # Required. The resource metric name. Supported metrics: * For Online Prediction: * `aiplatform.googleapis.com/prediction/online/accelerator/duty_cycle` * `aiplatform.googleapis.com/prediction/online/cpu/utilization` - "target": 42, # The target resource utilization in percentage (1% - 100%) for the given metric; once the real usage deviates from the target by a certain percentage, the machine replicas change. The default value is 60 (representing 60%) if not provided. - }, - ], - "machineSpec": { # Specification of a single machine. # Required. Immutable. The specification of a single machine used by the prediction. - "acceleratorCount": 42, # The number of accelerators to attach to the machine. - "acceleratorType": "A String", # Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count. - "machineType": "A String", # Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - "tpuTopology": "A String", # Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). - }, - "maxReplicaCount": 42, # Immutable. The maximum number of replicas this DeployedModel may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale the model to that many replicas is guaranteed (barring service outages). If traffic against the DeployedModel increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). - "minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. - }, - "largeModelReference": { # Contains information about the Large Model. # Optional. Large model reference. When this is set, model_artifact_spec is not needed. - "name": "A String", # Required. The unique name of the large Foundation or pre-built model. Like "chat-bison", "text-bison". Or model name with version ID, like "chat-bison@001", "text-bison@005", etc. - }, - "modelDisplayName": "A String", # Optional. Default model display name. - "publicArtifactUri": "A String", # Optional. The signed URI for ephemeral Cloud Storage access to model artifact. - "sharedResources": "A String", # The resource name of the shared DeploymentResourcePool to deploy on. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}` - "title": "A String", # Required. The title of the regional resource reference. - }, - ], - }, "openEvaluationPipeline": { # The regional resource name or the URI. Key is region, e.g., us-central1, europe-west2, global, etc.. # Optional. Open evaluation pipeline of the PublisherModel. "references": { # Required. "a_key": { # Reference to a resource. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index 31eceee089a..35fc0d6e39e 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -149,6 +149,11 @@

Instance Methods

Returns the googleAdsLinks Resource.

+

+ keyEvents() +

+

Returns the keyEvents Resource.

+

rollupPropertySourceLinks()

diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html new file mode 100644 index 00000000000..8fd370a4f42 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1alpha.properties.keyEvents.html @@ -0,0 +1,288 @@ + + + +

Google Analytics Admin API . properties . keyEvents

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Key Event.

+

+ delete(name, x__xgafv=None)

+

Deletes a Key Event.

+

+ get(name, x__xgafv=None)

+

Retrieve a single Key Event.

+

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

+

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Key Event.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Key Event.
+
+Args:
+  parent: string, Required. The resource name of the parent property where this Key Event will be created. Format: properties/123 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Key Event.
+
+Args:
+  name: string, Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieve a single Key Event.
+
+Args:
+  name: string, Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
+
+Args:
+  parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
+  pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListKeyEvents RPC.
+  "keyEvents": [ # The requested Key Events
+    { # A key event in a Google Analytics property.
+      "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+      "createTime": "A String", # Output only. Time when this key event was created in the property.
+      "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+      "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+        "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+        "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+      },
+      "deletable": True or False, # Output only. If set to true, this event can be deleted.
+      "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+      "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Key Event.
+
+Args:
+  name: string, Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/analyticsadmin_v1beta.properties.html b/docs/dyn/analyticsadmin_v1beta.properties.html index 27dfdd408c2..d93bedfd699 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.html @@ -104,6 +104,11 @@

Instance Methods

Returns the googleAdsLinks Resource.

+

+ keyEvents() +

+

Returns the keyEvents Resource.

+

acknowledgeUserDataCollection(property, body=None, x__xgafv=None)

Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.

diff --git a/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html new file mode 100644 index 00000000000..78826c78863 --- /dev/null +++ b/docs/dyn/analyticsadmin_v1beta.properties.keyEvents.html @@ -0,0 +1,288 @@ + + + +

Google Analytics Admin API . properties . keyEvents

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Key Event.

+

+ delete(name, x__xgafv=None)

+

Deletes a Key Event.

+

+ get(name, x__xgafv=None)

+

Retrieve a single Key Event.

+

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

+

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Key Event.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Key Event.
+
+Args:
+  parent: string, Required. The resource name of the parent property where this Key Event will be created. Format: properties/123 (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Key Event.
+
+Args:
+  name: string, Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieve a single Key Event.
+
+Args:
+  name: string, Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
+
+Args:
+  parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
+  pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
+  pageToken: string, A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListKeyEvents RPC.
+  "keyEvents": [ # The requested Key Events
+    { # A key event in a Google Analytics property.
+      "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+      "createTime": "A String", # Output only. Time when this key event was created in the property.
+      "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+      "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+        "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+        "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+      },
+      "deletable": True or False, # Output only. If set to true, this event can be deleted.
+      "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+      "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Key Event.
+
+Args:
+  name: string, Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A key event in a Google Analytics property.
+  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
+  "createTime": "A String", # Output only. Time when this key event was created in the property.
+  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
+  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
+    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
+    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
+  },
+  "deletable": True or False, # Output only. If set to true, this event can be deleted.
+  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
+  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index 0c6270e4352..7d6c186f5b8 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -437,7 +437,7 @@

Method Details

"a_key": "A String", }, }, - "lostPhoneNumber": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The phone number displayed to the user when the device is in lost mode. + "lostPhoneNumber": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # The phone number that will be called when the device is in lost mode and the call owner button is tapped. "defaultMessage": "A String", # The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. "localizedMessages": { # A map containing pairs, where locale is a well-formed BCP 47 language (https://www.w3.org/International/articles/language-tags/) code, such as en-US, es-ES, or fr. "a_key": "A String", diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 44f97c0daa0..af63dfedd12 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -168,7 +168,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command (https://developer.android.com/management/reference/rest/v1/enterprises.devices/issueCommand#CommandType) on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hash of the signing certificate of the extension app. Only hexadecimal string representations of 64 characters are valid.If not specified, the signature for the corresponding package name is obtained from the Play Store instead.If this list is empty, the signature of the extension app on the device must match the signature obtained from the Play Store for the app to be able to communicate with Android Device Policy.If this list is not empty, the signature of the extension app on the device must match one of the entries in this list for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -579,7 +579,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command (https://developer.android.com/management/reference/rest/v1/enterprises.devices/issueCommand#CommandType) on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hash of the signing certificate of the extension app. Only hexadecimal string representations of 64 characters are valid.If not specified, the signature for the corresponding package name is obtained from the Play Store instead.If this list is empty, the signature of the extension app on the device must match the signature obtained from the Play Store for the app to be able to communicate with Android Device Policy.If this list is not empty, the signature of the extension app on the device must match one of the entries in this list for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -996,7 +996,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command (https://developer.android.com/management/reference/rest/v1/enterprises.devices/issueCommand#CommandType) on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hash of the signing certificate of the extension app. Only hexadecimal string representations of 64 characters are valid.If not specified, the signature for the corresponding package name is obtained from the Play Store instead.If this list is empty, the signature of the extension app on the device must match the signature obtained from the Play Store for the app to be able to communicate with Android Device Policy.If this list is not empty, the signature of the extension app on the device must match one of the entries in this list for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -1396,7 +1396,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command (https://developer.android.com/management/reference/rest/v1/enterprises.devices/issueCommand#CommandType) on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 13 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hash of the signing certificate of the extension app. Only hexadecimal string representations of 64 characters are valid.If not specified, the signature for the corresponding package name is obtained from the Play Store instead.If this list is empty, the signature of the extension app on the device must match the signature obtained from the Play Store for the app to be able to communicate with Android Device Policy.If this list is not empty, the signature of the extension app on the device must match one of the entries in this list for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html index db6f0a2c8c3..d81dc585519 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html @@ -211,14 +211,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -329,14 +337,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -436,14 +452,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -535,14 +559,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -665,14 +697,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -769,14 +809,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -864,14 +912,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -978,14 +1034,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -1097,14 +1161,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -1204,14 +1276,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -1318,14 +1398,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, @@ -1419,14 +1507,22 @@

Method Details

"targeting": { # Defines the rule a user needs to satisfy to receive this offer. # The requirements that users need to fulfil to be eligible for this offer. Represents the requirements that Play will evaluate to decide whether an offer should be returned. Developers may further filter these offers themselves. "acquisitionRule": { # Represents a targeting rule of the form: User never had {scope} before. # Offer targeting rule for new user acquisition. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "any subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, "upgradeRule": { # Represents a targeting rule of the form: User currently has {scope} [with billing period {billing_period}]. # Offer targeting rule for upgrading users' existing plans. "billingPeriodDuration": "A String", # The specific billing period duration, specified in ISO 8601 format, that a user must be currently subscribed to to be eligible for this rule. If not specified, users subscribed to any billing period are matched. "oncePerUser": True or False, # Limit this offer to only once per user. If set to true, a user can never be eligible for this offer again if they ever subscribed to this offer. "scope": { # Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement. # Required. The scope of subscriptions this rule considers. Only allows "this subscription" and "specific subscription in app". + "anySubscriptionInApp": { # Represents the targeting rule scope corresponding to any subscription in the parent app. # The scope of the current targeting rule is any subscription in the parent app. + }, "specificSubscriptionInApp": "A String", # The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app. + "thisSubscription": { # Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined. # The scope of the current targeting rule is the subscription in which this offer is defined. + }, }, }, }, diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index 58162a02e48..92078e683ad 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -1970,7 +1970,7 @@

Method Details

Args: calendarId: string, Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword. (required) alwaysIncludeEmail: boolean, Deprecated and ignored. - eventTypes: string, Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. The default is ["default", "focusTime", "outOfOffice"]. (repeated) + eventTypes: string, Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. (repeated) Allowed values default - Regular events. focusTime - Focus time events. @@ -4176,7 +4176,7 @@

Method Details

} alwaysIncludeEmail: boolean, Deprecated and ignored. - eventTypes: string, Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. The default is ["default", "focusTime", "outOfOffice"]. (repeated) + eventTypes: string, Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types. (repeated) Allowed values default - Regular events. focusTime - Focus time events. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 0d826fc686b..3398c13b7a0 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Returns a SpaceEvent. You can request events from up to 28 days before the time of the request. The server will return the most recent version of the resource. For example, if a `google.workspace.chat.message.v1.created` event is requested and the message has since been deleted, the returned event will contain the deleted message resource in the payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).

+

Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).

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

-

Lists SpaceEvents in a space that the caller is a member of. You can request events from up to 28 days before the time of the request. The server will return the most recent version of the resources. For example, if a `google.workspace.chat.message.v1.created` event is requested and the message has since been deleted, the returned event will contain the deleted message resource in the payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).

+

Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).

list_next()

Retrieves the next page of results.

@@ -94,10 +94,10 @@

Method Details

get(name, x__xgafv=None) -
Returns a SpaceEvent. You can request events from up to 28 days before the time of the request. The server will return the most recent version of the resource. For example, if a `google.workspace.chat.message.v1.created` event is requested and the message has since been deleted, the returned event will contain the deleted message resource in the payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).
+  
Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).
 
 Args:
-  name: string, Required. The resource name of the event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` (required)
+  name: string, Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,13 +106,13 @@ 

Method Details

Returns: An object of the form: - { # An event that happens in a specific space. - "eventTime": "A String", # Time of the event. - "eventType": "A String", # Type of the space event. The following event types are supported: * New membership: `google.workspace.chat.membership.v1.created` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Updated membership: `google.workspace.chat.membership.v1.updated` * New message: `google.workspace.chat.message.v1.created` * Deleted message: `google.workspace.chat.message.v1.deleted` * Updated message: `google.workspace.chat.message.v1.updated` * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Updated space: `google.workspace.chat.space.v1.updated` Note that requesting or subscribing to the preceding event types automatically sets up the subscription or response to also return batched versions of the event type. For example, if you subscribe to `google.workspace.chat.membership.v1.created`, you also receive events for `google.workspace.chat.membership.v1.batchCreated`. For more details see https://developers.google.com/workspace/events/guides/events-chat#output_only_event_types. - "membershipBatchCreatedEventData": { # Payload for batch new membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchCreated`. # Payload for batch new membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchCreated`. - "memberships": [ # A list of created memberships. - { # Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + { # An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). + "eventTime": "A String", # Time when the event occurred. + "eventType": "A String", # Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated` + "membershipBatchCreatedEventData": { # Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated` # Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated` + "memberships": [ # A list of new memberships. + { # Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`. + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The new membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -132,10 +132,10 @@

Method Details

}, ], }, - "membershipBatchDeletedEventData": { # Payload for batch deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchDeleted`. # Payload for batch deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchDeleted`. + "membershipBatchDeletedEventData": { # Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted` # Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted` "memberships": [ # A list of deleted memberships. - { # Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only `name` and `state` are populated. + { # Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only the `name` and `state` fields are populated. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -155,10 +155,10 @@

Method Details

}, ], }, - "membershipBatchUpdatedEventData": { # Payload for batch updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchUpdated`. # Payload for batch updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchUpdated`. + "membershipBatchUpdatedEventData": { # Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated` # Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated` "memberships": [ # A list of updated memberships. - { # Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + { # Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The updated membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -178,8 +178,8 @@

Method Details

}, ], }, - "membershipCreatedEventData": { # Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`. # Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + "membershipCreatedEventData": { # Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`. # Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The new membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -197,8 +197,8 @@

Method Details

"state": "A String", # Output only. State of the membership. }, }, - "membershipDeletedEventData": { # Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`. # Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only `name` and `state` are populated. + "membershipDeletedEventData": { # Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` # Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only the `name` and `state` fields are populated. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -216,8 +216,8 @@

Method Details

"state": "A String", # Output only. State of the membership. }, }, - "membershipUpdatedEventData": { # Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`. # Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + "membershipUpdatedEventData": { # Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` # Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The updated membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -235,10 +235,10 @@

Method Details

"state": "A String", # Output only. State of the membership. }, }, - "messageBatchCreatedEventData": { # Payload for batch new message events where the `EventType` field is `google.workspace.chat.message.v1.batchCreated`. # Payload for batch new message events where the `EventType` field is `google.workspace.chat.message.v1.batchCreated`. - "messages": [ # A list of created messages. - { # Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + "messageBatchCreatedEventData": { # Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated` # Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated` + "messages": [ # A list of new messages. + { # Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` + "message": { # A message in a Google Chat space. # The new message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -1993,10 +1993,10 @@

Method Details

}, ], }, - "messageBatchDeletedEventData": { # Payload for batch deleted message events where the `EventType` field is `google.workspace.chat.message.v1.batchDeleted`. # Payload for batch deleted message events where the `EventType` field is `google.workspace.chat.message.v1.batchDeleted`. + "messageBatchDeletedEventData": { # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` "messages": [ # A list of deleted messages. - { # Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`. - "message": { # A message in a Google Chat space. # The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated. + { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` + "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -3751,10 +3751,10 @@

Method Details

}, ], }, - "messageBatchUpdatedEventData": { # Payload for batch updated message events where the `EventType` field is `google.workspace.chat.message.v1.batchUpdated`. # Payload for batch updated message events where the `EventType` field is `google.workspace.chat.message.v1.batchUpdated`. + "messageBatchUpdatedEventData": { # Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated` # Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated` "messages": [ # A list of updated messages. - { # Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + { # Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` + "message": { # A message in a Google Chat space. # The updated message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -5509,8 +5509,8 @@

Method Details

}, ], }, - "messageCreatedEventData": { # Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`. # Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + "messageCreatedEventData": { # Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` # Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` + "message": { # A message in a Google Chat space. # The new message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -7263,8 +7263,8 @@

Method Details

"threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. }, }, - "messageDeletedEventData": { # Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`. # Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`. - "message": { # A message in a Google Chat space. # The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated. + "messageDeletedEventData": { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` + "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -9017,8 +9017,8 @@

Method Details

"threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. }, }, - "messageUpdatedEventData": { # Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`. # Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + "messageUpdatedEventData": { # Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` # Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` + "message": { # A message in a Google Chat space. # The updated message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -10771,11 +10771,11 @@

Method Details

"threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. }, }, - "name": "A String", # The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` - "reactionBatchCreatedEventData": { # Payload for batch new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchCreated`. # Payload for batch new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchCreated`. - "reactions": [ # A list of created reactions. - { # Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`. - "reaction": { # A reaction to a message. # The created reaction. + "name": "A String", # Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` + "reactionBatchCreatedEventData": { # Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated` # Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated` + "reactions": [ # A list of new reactions. + { # Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` + "reaction": { # A reaction to a message. # The new reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. "uid": "A String", # Unique key for the custom emoji resource. @@ -10794,9 +10794,9 @@

Method Details

}, ], }, - "reactionBatchDeletedEventData": { # Payload for batch deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchDeleted`. # Payload for batch deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchDeleted`. + "reactionBatchDeletedEventData": { # Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted` # Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted` "reactions": [ # A list of deleted reactions. - { # Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`. + { # Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted` "reaction": { # A reaction to a message. # The deleted reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. @@ -10816,8 +10816,8 @@

Method Details

}, ], }, - "reactionCreatedEventData": { # Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`. # Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`. - "reaction": { # A reaction to a message. # The created reaction. + "reactionCreatedEventData": { # Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` # Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` + "reaction": { # A reaction to a message. # The new reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. "uid": "A String", # Unique key for the custom emoji resource. @@ -10834,7 +10834,7 @@

Method Details

}, }, }, - "reactionDeletedEventData": { # Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`. # Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`. + "reactionDeletedEventData": { # Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted` # Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted` "reaction": { # A reaction to a message. # The deleted reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. @@ -10852,10 +10852,10 @@

Method Details

}, }, }, - "spaceBatchUpdatedEventData": { # Payload for batch updated space events where the `EventType` field is `google.workspace.chat.space.v1.batchUpdated`. # Payload for batch updated space events where the `EventType` field is `google.workspace.chat.space.v1.batchUpdated`. + "spaceBatchUpdatedEventData": { # Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated` # Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated` "spaces": [ # A list of updated spaces. - { # Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`. - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The recent version of the space. + { # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "adminInstalled": True or False, # Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. @@ -10876,8 +10876,8 @@

Method Details

}, ], }, - "spaceUpdatedEventData": { # Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`. # Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`. - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The recent version of the space. + "spaceUpdatedEventData": { # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` # Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated` + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "adminInstalled": True or False, # Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. @@ -10901,12 +10901,12 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists SpaceEvents in a space that the caller is a member of. You can request events from up to 28 days before the time of the request. The server will return the most recent version of the resources. For example, if a `google.workspace.chat.message.v1.created` event is requested and the message has since been deleted, the returned event will contain the deleted message resource in the payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).
+  
Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).
 
 Args:
-  parent: string, Required. The resource name of the space from which to list events. Format: `spaces/{space}`. (required)
-  filter: string, Required. A query filter. This method supports filtering by: `event_types`, `start_time`, and `end_time`. `event_types`: You must specify at least one event type in your query. `event_types` supports the has `:` operator. To filter by multiple event types, use the `OR` operator. To see the list of currently supported event types, see google.chat.v1.SpaceEvent.event_type `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the 28 days ago up to end time. `end_time`: Inclusive timestamp up to which space events are listed. Default value is the present. `start_time` and `end_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and support the equals `=` comparison operator. To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" ``` ``` start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") ``` The following queries are invalid: ``` start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" ``` ``` event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
-  pageSize: integer, Optional. The maximum number of space events returned. The service may return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.
+  parent: string, Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`. (required)
+  filter: string, Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00" ``` ``` start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created") ``` The following queries are invalid: ``` start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00" ``` ``` event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
+  pageSize: integer, Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.
   pageToken: string, A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -10919,13 +10919,13 @@ 

Method Details

{ # Response message for listing space events. "nextPageToken": "A String", # Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages. "spaceEvents": [ # Results are returned in chronological order (oldest event first). - { # An event that happens in a specific space. - "eventTime": "A String", # Time of the event. - "eventType": "A String", # Type of the space event. The following event types are supported: * New membership: `google.workspace.chat.membership.v1.created` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Updated membership: `google.workspace.chat.membership.v1.updated` * New message: `google.workspace.chat.message.v1.created` * Deleted message: `google.workspace.chat.message.v1.deleted` * Updated message: `google.workspace.chat.message.v1.updated` * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Updated space: `google.workspace.chat.space.v1.updated` Note that requesting or subscribing to the preceding event types automatically sets up the subscription or response to also return batched versions of the event type. For example, if you subscribe to `google.workspace.chat.membership.v1.created`, you also receive events for `google.workspace.chat.membership.v1.batchCreated`. For more details see https://developers.google.com/workspace/events/guides/events-chat#output_only_event_types. - "membershipBatchCreatedEventData": { # Payload for batch new membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchCreated`. # Payload for batch new membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchCreated`. - "memberships": [ # A list of created memberships. - { # Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + { # An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). + "eventTime": "A String", # Time when the event occurred. + "eventType": "A String", # Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated` + "membershipBatchCreatedEventData": { # Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated` # Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated` + "memberships": [ # A list of new memberships. + { # Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`. + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The new membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -10945,10 +10945,10 @@

Method Details

}, ], }, - "membershipBatchDeletedEventData": { # Payload for batch deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchDeleted`. # Payload for batch deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchDeleted`. + "membershipBatchDeletedEventData": { # Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted` # Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted` "memberships": [ # A list of deleted memberships. - { # Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only `name` and `state` are populated. + { # Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only the `name` and `state` fields are populated. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -10968,10 +10968,10 @@

Method Details

}, ], }, - "membershipBatchUpdatedEventData": { # Payload for batch updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchUpdated`. # Payload for batch updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchUpdated`. + "membershipBatchUpdatedEventData": { # Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated` # Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated` "memberships": [ # A list of updated memberships. - { # Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + { # Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The updated membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -10991,8 +10991,8 @@

Method Details

}, ], }, - "membershipCreatedEventData": { # Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`. # Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + "membershipCreatedEventData": { # Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`. # Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The new membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -11010,8 +11010,8 @@

Method Details

"state": "A String", # Output only. State of the membership. }, }, - "membershipDeletedEventData": { # Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`. # Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only `name` and `state` are populated. + "membershipDeletedEventData": { # Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` # Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The deleted membership. Only the `name` and `state` fields are populated. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -11029,8 +11029,8 @@

Method Details

"state": "A String", # Output only. State of the membership. }, }, - "membershipUpdatedEventData": { # Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`. # Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`. - "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The most recent version of membership. + "membershipUpdatedEventData": { # Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` # Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated` + "membership": { # Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space. # The updated membership. "createTime": "A String", # Optional. Immutable. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. "deleteTime": "A String", # Optional. Immutable. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. "groupMember": { # A Google Group in Google Chat. # The Google Group the membership corresponds to. Only supports read operations. Other operations, like creating or updating a membership, aren't currently supported. @@ -11048,10 +11048,10 @@

Method Details

"state": "A String", # Output only. State of the membership. }, }, - "messageBatchCreatedEventData": { # Payload for batch new message events where the `EventType` field is `google.workspace.chat.message.v1.batchCreated`. # Payload for batch new message events where the `EventType` field is `google.workspace.chat.message.v1.batchCreated`. - "messages": [ # A list of created messages. - { # Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + "messageBatchCreatedEventData": { # Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated` # Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated` + "messages": [ # A list of new messages. + { # Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` + "message": { # A message in a Google Chat space. # The new message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -12806,10 +12806,10 @@

Method Details

}, ], }, - "messageBatchDeletedEventData": { # Payload for batch deleted message events where the `EventType` field is `google.workspace.chat.message.v1.batchDeleted`. # Payload for batch deleted message events where the `EventType` field is `google.workspace.chat.message.v1.batchDeleted`. + "messageBatchDeletedEventData": { # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` # Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted` "messages": [ # A list of deleted messages. - { # Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`. - "message": { # A message in a Google Chat space. # The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated. + { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` + "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -14564,10 +14564,10 @@

Method Details

}, ], }, - "messageBatchUpdatedEventData": { # Payload for batch updated message events where the `EventType` field is `google.workspace.chat.message.v1.batchUpdated`. # Payload for batch updated message events where the `EventType` field is `google.workspace.chat.message.v1.batchUpdated`. + "messageBatchUpdatedEventData": { # Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated` # Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated` "messages": [ # A list of updated messages. - { # Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + { # Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` + "message": { # A message in a Google Chat space. # The updated message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -16322,8 +16322,8 @@

Method Details

}, ], }, - "messageCreatedEventData": { # Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`. # Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + "messageCreatedEventData": { # Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` # Event payload for a new message. Event type: `google.workspace.chat.message.v1.created` + "message": { # A message in a Google Chat space. # The new message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -18076,8 +18076,8 @@

Method Details

"threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. }, }, - "messageDeletedEventData": { # Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`. # Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`. - "message": { # A message in a Google Chat space. # The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated. + "messageDeletedEventData": { # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` # Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted` + "message": { # A message in a Google Chat space. # The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -19830,8 +19830,8 @@

Method Details

"threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. }, }, - "messageUpdatedEventData": { # Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`. # Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`. - "message": { # A message in a Google Chat space. # The most recent version of the message. + "messageUpdatedEventData": { # Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` # Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated` + "message": { # A message in a Google Chat space. # The updated message. "accessoryWidgets": [ # One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). Creating a message with accessory widgets requires [app authentication] (https://developers.google.com/chat/api/guides/auth/service-accounts). { # One or more interactive widgets that appear at the bottom of a message. For details, see [Add interactive widgets at the bottom of a message](https://developers.google.com/workspace/chat/create-messages#add-accessory-widgets). "buttonList": { # A list of buttons layed out horizontally. For an example in Google Chat apps, see [Button list](https://developers.google.com/chat/ui/widgets/button-list). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): # A list of buttons. @@ -21584,11 +21584,11 @@

Method Details

"threadReply": True or False, # Output only. When `true`, the message is a response in a reply thread. When `false`, the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies. If the space doesn't support reply in threads, this field is always `false`. }, }, - "name": "A String", # The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` - "reactionBatchCreatedEventData": { # Payload for batch new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchCreated`. # Payload for batch new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchCreated`. - "reactions": [ # A list of created reactions. - { # Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`. - "reaction": { # A reaction to a message. # The created reaction. + "name": "A String", # Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}` + "reactionBatchCreatedEventData": { # Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated` # Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated` + "reactions": [ # A list of new reactions. + { # Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` + "reaction": { # A reaction to a message. # The new reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. "uid": "A String", # Unique key for the custom emoji resource. @@ -21607,9 +21607,9 @@

Method Details

}, ], }, - "reactionBatchDeletedEventData": { # Payload for batch deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchDeleted`. # Payload for batch deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchDeleted`. + "reactionBatchDeletedEventData": { # Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted` # Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted` "reactions": [ # A list of deleted reactions. - { # Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`. + { # Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted` "reaction": { # A reaction to a message. # The deleted reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. @@ -21629,8 +21629,8 @@

Method Details

}, ], }, - "reactionCreatedEventData": { # Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`. # Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`. - "reaction": { # A reaction to a message. # The created reaction. + "reactionCreatedEventData": { # Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` # Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created` + "reaction": { # A reaction to a message. # The new reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. "uid": "A String", # Unique key for the custom emoji resource. @@ -21647,7 +21647,7 @@

Method Details

}, }, }, - "reactionDeletedEventData": { # Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`. # Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`. + "reactionDeletedEventData": { # Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted` # Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted` "reaction": { # A reaction to a message. # The deleted reaction. "emoji": { # An emoji that is used as a reaction to a message. # The emoji used in the reaction. "customEmoji": { # Represents a custom emoji. # Output only. A custom emoji. @@ -21665,10 +21665,10 @@

Method Details

}, }, }, - "spaceBatchUpdatedEventData": { # Payload for batch updated space events where the `EventType` field is `google.workspace.chat.space.v1.batchUpdated`. # Payload for batch updated space events where the `EventType` field is `google.workspace.chat.space.v1.batchUpdated`. + "spaceBatchUpdatedEventData": { # Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated` # Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated` "spaces": [ # A list of updated spaces. - { # Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`. - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The recent version of the space. + { # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "adminInstalled": True or False, # Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. @@ -21689,8 +21689,8 @@

Method Details

}, ], }, - "spaceUpdatedEventData": { # Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`. # Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`. - "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The recent version of the space. + "spaceUpdatedEventData": { # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` # Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated` + "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "adminInstalled": True or False, # Output only. Whether the Chat app was installed by a Google Workspace administrator. Administrators can install a Chat app for their domain, organizational unit, or a group of users. Administrators can only install Chat apps for direct messaging between users and the app. To support admin install, your app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. diff --git a/docs/dyn/cloudsupport_v2.cases.comments.html b/docs/dyn/cloudsupport_v2.cases.comments.html index 855bba7d2e8..7efb2d9608d 100644 --- a/docs/dyn/cloudsupport_v2.cases.comments.html +++ b/docs/dyn/cloudsupport_v2.cases.comments.html @@ -101,17 +101,17 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. - "body": "A String", # The full comment body. Maximum of 12800 characters. This can contain rich text syntax. - "createTime": "A String", # Output only. The time when this comment was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment. +{ # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + "body": "A String", # The full comment body. Maximum of 12800 characters. + "createTime": "A String", # Output only. The time when the comment was created. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. }, - "name": "A String", # Output only. The resource name for the comment. - "plainTextBody": "A String", # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. + "name": "A String", # Output only. Identifier. The resource name of the comment. + "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. } x__xgafv: string, V1 error format. @@ -122,17 +122,17 @@

Method Details

Returns: An object of the form: - { # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. - "body": "A String", # The full comment body. Maximum of 12800 characters. This can contain rich text syntax. - "createTime": "A String", # Output only. The time when this comment was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment. + { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + "body": "A String", # The full comment body. Maximum of 12800 characters. + "createTime": "A String", # Output only. The time when the comment was created. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. }, - "name": "A String", # Output only. The resource name for the comment. - "plainTextBody": "A String", # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. + "name": "A String", # Output only. Identifier. The resource name of the comment. + "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. }
@@ -154,17 +154,17 @@

Method Details

{ # The response message for the ListComments endpoint. "comments": [ # List of the comments associated with the case. - { # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. - "body": "A String", # The full comment body. Maximum of 12800 characters. This can contain rich text syntax. - "createTime": "A String", # Output only. The time when this comment was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment. + { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + "body": "A String", # The full comment body. Maximum of 12800 characters. + "createTime": "A String", # Output only. The time when the comment was created. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. }, - "name": "A String", # Output only. The resource name for the comment. - "plainTextBody": "A String", # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. + "name": "A String", # Output only. Identifier. The resource name of the comment. + "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.comments.list` requests. If unspecified, there are no more results to retrieve. diff --git a/docs/dyn/cloudsupport_v2beta.cases.comments.html b/docs/dyn/cloudsupport_v2beta.cases.comments.html index 3ccd9ed837e..8f6e5e74f6b 100644 --- a/docs/dyn/cloudsupport_v2beta.cases.comments.html +++ b/docs/dyn/cloudsupport_v2beta.cases.comments.html @@ -101,17 +101,17 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. - "body": "A String", # The full comment body. Maximum of 12800 characters. This can contain rich text syntax. - "createTime": "A String", # Output only. The time when this comment was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment. +{ # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + "body": "A String", # The full comment body. Maximum of 12800 characters. + "createTime": "A String", # Output only. The time when the comment was created. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. }, - "name": "A String", # Output only. The resource name for the comment. - "plainTextBody": "A String", # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. + "name": "A String", # Output only. Identifier. The resource name of the comment. + "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. } x__xgafv: string, V1 error format. @@ -122,17 +122,17 @@

Method Details

Returns: An object of the form: - { # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. - "body": "A String", # The full comment body. Maximum of 12800 characters. This can contain rich text syntax. - "createTime": "A String", # Output only. The time when this comment was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment. + { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + "body": "A String", # The full comment body. Maximum of 12800 characters. + "createTime": "A String", # Output only. The time when the comment was created. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. }, - "name": "A String", # Output only. The resource name for the comment. - "plainTextBody": "A String", # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. + "name": "A String", # Output only. Identifier. The resource name of the comment. + "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. }
@@ -154,17 +154,17 @@

Method Details

{ # The response message for the ListComments endpoint. "comments": [ # List of the comments associated with the case. - { # Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. - "body": "A String", # The full comment body. Maximum of 12800 characters. This can contain rich text syntax. - "createTime": "A String", # Output only. The time when this comment was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent created this comment. + { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments. + "body": "A String", # The full comment body. Maximum of 12800 characters. + "createTime": "A String", # Output only. The time when the comment was created. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use **username** field instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set. }, - "name": "A String", # Output only. The resource name for the comment. - "plainTextBody": "A String", # Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. + "name": "A String", # Output only. Identifier. The resource name of the comment. + "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons. }, ], "nextPageToken": "A String", # A token to retrieve the next page of results. Set this in the `page_token` field of subsequent `cases.comments.list` requests. If unspecified, there are no more results to retrieve. diff --git a/docs/dyn/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index 8d527683ec4..1a148493ecd 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -261,6 +261,20 @@

Method Details

{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages (0-100) for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. It is valid to specify percentages for some classes and not for others. The others will be implicitly marked as 0. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "enabled": True or False, # Enable or disable the AAI feature on this interconnect. + "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], @@ -533,6 +547,20 @@

Method Details

{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages (0-100) for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. It is valid to specify percentages for some classes and not for others. The others will be implicitly marked as 0. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "enabled": True or False, # Enable or disable the AAI feature on this interconnect. + "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], @@ -742,6 +770,20 @@

Method Details

"items": [ # A list of Interconnect resources. { # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages (0-100) for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. It is valid to specify percentages for some classes and not for others. The others will be implicitly marked as 0. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "enabled": True or False, # Enable or disable the AAI feature on this interconnect. + "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], @@ -851,6 +893,20 @@

Method Details

{ # Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the Google Cloud network and your on-premises network. For more information, read the Dedicated Interconnect Overview. "adminEnabled": True or False, # Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. + "applicationAwareInterconnect": { # Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. # Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router. + "bandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages (0-100) for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. It is valid to specify percentages for some classes and not for others. The others will be implicitly marked as 0. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, + "enabled": True or False, # Enable or disable the AAI feature on this interconnect. + "profileDescription": "A String", # A description for the AAI profile on this interconnect. + "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. + }, + }, "availableFeatures": [ # [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. "A String", ], diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html index 908c424430b..ec03791c8b2 100644 --- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html @@ -974,6 +974,7 @@

Method Details

{ "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. + "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index 389664e0f3d..abf85c0b155 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -358,7 +358,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -417,7 +417,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -506,8 +506,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -989,7 +989,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1048,7 +1048,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1137,8 +1137,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1884,7 +1884,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1943,7 +1943,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2032,8 +2032,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2545,7 +2545,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2604,7 +2604,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2693,8 +2693,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -3326,7 +3326,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3385,7 +3385,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3474,8 +3474,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4076,7 +4076,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4135,7 +4135,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4224,8 +4224,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html index 8568624bc69..eac7e02f418 100644 --- a/docs/dyn/compute_alpha.urlMaps.html +++ b/docs/dyn/compute_alpha.urlMaps.html @@ -243,7 +243,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -302,7 +302,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -391,8 +391,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1053,7 +1053,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1112,7 +1112,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1201,8 +1201,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1683,7 +1683,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1742,7 +1742,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1831,8 +1831,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2576,7 +2576,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2635,7 +2635,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2724,8 +2724,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -3236,7 +3236,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3295,7 +3295,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3384,8 +3384,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4015,7 +4015,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4074,7 +4074,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4163,8 +4163,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4767,7 +4767,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4826,7 +4826,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4915,8 +4915,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index 41550b99c49..7042e4151b2 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -357,7 +357,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -416,7 +416,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -505,8 +505,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -986,7 +986,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1045,7 +1045,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1134,8 +1134,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1877,7 +1877,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1936,7 +1936,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2025,8 +2025,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2536,7 +2536,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2595,7 +2595,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2684,8 +2684,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -3314,7 +3314,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3373,7 +3373,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3462,8 +3462,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4061,7 +4061,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4120,7 +4120,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4209,8 +4209,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index 229b32046fd..7f904e2ea6d 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -243,7 +243,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -302,7 +302,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -391,8 +391,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1050,7 +1050,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1109,7 +1109,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1198,8 +1198,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1678,7 +1678,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1737,7 +1737,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1826,8 +1826,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2567,7 +2567,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2626,7 +2626,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2715,8 +2715,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -3225,7 +3225,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3284,7 +3284,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3373,8 +3373,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4001,7 +4001,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4060,7 +4060,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4149,8 +4149,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4750,7 +4750,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4809,7 +4809,7 @@

Method Details

], "errorService": "A String", # The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers. }, - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4898,8 +4898,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. diff --git a/docs/dyn/compute_v1.regionUrlMaps.html b/docs/dyn/compute_v1.regionUrlMaps.html index f957b380650..b7a1b4201d0 100644 --- a/docs/dyn/compute_v1.regionUrlMaps.html +++ b/docs/dyn/compute_v1.regionUrlMaps.html @@ -339,7 +339,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -386,7 +386,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -475,8 +475,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -906,7 +906,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -953,7 +953,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1042,8 +1042,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1602,7 +1602,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1649,7 +1649,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1738,8 +1738,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2199,7 +2199,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2246,7 +2246,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2335,8 +2335,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2883,7 +2883,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2930,7 +2930,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3019,8 +3019,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -3568,7 +3568,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3615,7 +3615,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3704,8 +3704,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html index c346fbd1937..7e4542d534b 100644 --- a/docs/dyn/compute_v1.urlMaps.html +++ b/docs/dyn/compute_v1.urlMaps.html @@ -228,7 +228,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -275,7 +275,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -364,8 +364,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -973,7 +973,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1020,7 +1020,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1109,8 +1109,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -1539,7 +1539,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -1586,7 +1586,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -1675,8 +1675,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2366,7 +2366,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -2413,7 +2413,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -2502,8 +2502,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -2962,7 +2962,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3009,7 +3009,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3098,8 +3098,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -3645,7 +3645,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -3692,7 +3692,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -3781,8 +3781,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. @@ -4332,7 +4332,7 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + "defaultService": "A String", # The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. @@ -4379,7 +4379,7 @@

Method Details

"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. "pathMatchers": [ # The list of named PathMatchers to use against the URL. { # A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service is used. - "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. + "defaultRouteAction": { # defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. "corsPolicy": { # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. # The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy. "allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false. "allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header. @@ -4468,8 +4468,8 @@

Method Details

}, ], }, - "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use - "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy. + "defaultService": "A String", # The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use + "defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy. "hostRedirect": "A String", # The host that is used in the redirect response instead of the one that was supplied in the request. The value must be from 1 to 255 characters. "httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to HTTPS. If set to false, the URL scheme of the redirected request remains the same as that of the request. This must only be set for URL maps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false. "pathRedirect": "A String", # The path that is used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request is used for the redirect. The value must be from 1 to 1024 characters. diff --git a/docs/dyn/content_v2_1.merchantsupport.html b/docs/dyn/content_v2_1.merchantsupport.html index d176ce0a81d..c135151832c 100644 --- a/docs/dyn/content_v2_1.merchantsupport.html +++ b/docs/dyn/content_v2_1.merchantsupport.html @@ -83,6 +83,9 @@

Instance Methods

renderproductissues(merchantId, productId, body=None, languageCode=None, timeZone=None, x__xgafv=None)

Provide a list of issues for merchant's product with a support content and available actions. This content and actions are meant to be rendered and shown in third-party applications.

+

+ triggeraction(merchantId, body=None, languageCode=None, x__xgafv=None)

+

Start an action. The action can be requested by merchants in third-party application. Before merchants can request the action, the third-party application needs to show them action specific content and display a user input form. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.

Method Details

close() @@ -100,6 +103,7 @@

Method Details

{ # The payload for configuring how the content should be rendered. "contentOption": "A String", # Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text. + "userInputActionOption": "A String", # Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action. } languageCode: string, Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize support content. If not set, the result will be in default language `en-US`. @@ -131,6 +135,66 @@

Method Details

"attributeCode": "A String", # The attribute that needs to be updated. Present when the type is `EDIT_ITEM_ATTRIBUTE`. This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes [here](https://support.google.com/merchants/answer/7052112). "type": "A String", # The type of action that represents a functionality that is expected to be available in third-party application. }, + "builtinUserInputAction": { # Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the [triggeraction method](https://developers.google.com/shopping-content/reference/rest/v2.1/merchantsupport/triggeraction). # Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant as specified for given action. They can trigger the action only when they provided all required inputs. + "actionContext": "A String", # Internal details. Not for display but need to be sent back when triggering the action. + "flows": [ # Actions may provide multiple different flows. Merchant selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed. + { # Flow that can be selected for an action. When merchant selects a flow, application should open a dialog with more information and input form. + "dialogButtonLabel": "A String", # Label for the button to trigger the action from the action dialog. For example: "Request review" + "dialogCallout": { # An important message that should be highlighted. Usually displayed as a banner. # Important message to be highlighted in the request dialog. For example: "You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review." + "fullMessage": { # Block of text that may contain a tooltip with more information. # A full message that needs to be shown to the merchant. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "styleHint": "A String", # Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to merchants. + }, + "dialogMessage": { # Block of text that may contain a tooltip with more information. # Message displayed in the request dialog. For example: "Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review". There may be an more information to be shown in a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "dialogTitle": "A String", # Title of the request dialog. For example: "Before you request a review" + "id": "A String", # Not for display but need to be sent back for the selected action flow. + "inputs": [ # A list of input fields. + { # Input field that needs to be available to the merchant. If the field is marked as required, then a value needs to be provided for a successful processing of the request. + "checkboxInput": { # Checkbox input allows merchants to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). If merchant checks the box, the input value for the field is `true`, otherwise it is `false`. This type of input is often used as a confirmation that the merchant completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the merchant checks the box. # Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). + }, + "choiceInput": { # Choice input allows merchants to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the merchant. For example, additional input field can be hidden or disabled until the merchant selects the specific choice. # Input field to select one of the offered choices. Corresponds to the [html input type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio). + "options": [ # A list of choices. Only one option can be selected. + { # A choice that merchant can select. + "additionalInput": # Object with schema name: InputField # Input that should be displayed when this option is selected. The additional input will not contain a `ChoiceInput`. + "id": "A String", # Not for display but need to be sent back for the selected choice option. + "label": { # Block of text that may contain a tooltip with more information. # Short description of the choice option. There may be more information to be shown as a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + }, + ], + }, + "id": "A String", # Not for display but need to be sent back for the given input field. + "label": { # Block of text that may contain a tooltip with more information. # Input field label. There may be more information to be shown in a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "required": True or False, # Whether the field is required. The action button needs to stay disabled till values for all required fields are provided. + "textInput": { # Text input allows merchants to provide a text value. # Input field to provide text information. Corresponds to the [html input type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea). + "additionalInfo": { # Block of text that may contain a tooltip with more information. # Additional info regarding the field to be displayed to merchant. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "ariaLabel": "A String", # Text to be used as the [aria label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the input. + "formatInfo": "A String", # Information about the required format. If present, it should be shown close to the input field to help merchants to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999" + "type": "A String", # Type of the text input + }, + }, + ], + "label": "A String", # Text value describing the intent for the action flow. It can be used as an input label if merchant needs to pick one of multiple flows. For example: "I disagree with the issue" + }, + ], + }, "buttonLabel": "A String", # Label of the action button. "externalAction": { # Action that is implemented and performed outside of the third-party application. It should redirect the merchant to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center. # Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the merchant to the external location where they can perform the action. "type": "A String", # The type of external action. @@ -182,6 +246,7 @@

Method Details

{ # The payload for configuring how the content should be rendered. "contentOption": "A String", # Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text. + "userInputActionOption": "A String", # Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action. } languageCode: string, Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize support content. If not set, the result will be in default language `en-US`. @@ -213,6 +278,66 @@

Method Details

"attributeCode": "A String", # The attribute that needs to be updated. Present when the type is `EDIT_ITEM_ATTRIBUTE`. This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes [here](https://support.google.com/merchants/answer/7052112). "type": "A String", # The type of action that represents a functionality that is expected to be available in third-party application. }, + "builtinUserInputAction": { # Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the [triggeraction method](https://developers.google.com/shopping-content/reference/rest/v2.1/merchantsupport/triggeraction). # Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant as specified for given action. They can trigger the action only when they provided all required inputs. + "actionContext": "A String", # Internal details. Not for display but need to be sent back when triggering the action. + "flows": [ # Actions may provide multiple different flows. Merchant selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed. + { # Flow that can be selected for an action. When merchant selects a flow, application should open a dialog with more information and input form. + "dialogButtonLabel": "A String", # Label for the button to trigger the action from the action dialog. For example: "Request review" + "dialogCallout": { # An important message that should be highlighted. Usually displayed as a banner. # Important message to be highlighted in the request dialog. For example: "You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review." + "fullMessage": { # Block of text that may contain a tooltip with more information. # A full message that needs to be shown to the merchant. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "styleHint": "A String", # Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to merchants. + }, + "dialogMessage": { # Block of text that may contain a tooltip with more information. # Message displayed in the request dialog. For example: "Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review". There may be an more information to be shown in a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "dialogTitle": "A String", # Title of the request dialog. For example: "Before you request a review" + "id": "A String", # Not for display but need to be sent back for the selected action flow. + "inputs": [ # A list of input fields. + { # Input field that needs to be available to the merchant. If the field is marked as required, then a value needs to be provided for a successful processing of the request. + "checkboxInput": { # Checkbox input allows merchants to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). If merchant checks the box, the input value for the field is `true`, otherwise it is `false`. This type of input is often used as a confirmation that the merchant completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the merchant checks the box. # Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). + }, + "choiceInput": { # Choice input allows merchants to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the merchant. For example, additional input field can be hidden or disabled until the merchant selects the specific choice. # Input field to select one of the offered choices. Corresponds to the [html input type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio). + "options": [ # A list of choices. Only one option can be selected. + { # A choice that merchant can select. + "additionalInput": # Object with schema name: InputField # Input that should be displayed when this option is selected. The additional input will not contain a `ChoiceInput`. + "id": "A String", # Not for display but need to be sent back for the selected choice option. + "label": { # Block of text that may contain a tooltip with more information. # Short description of the choice option. There may be more information to be shown as a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + }, + ], + }, + "id": "A String", # Not for display but need to be sent back for the given input field. + "label": { # Block of text that may contain a tooltip with more information. # Input field label. There may be more information to be shown in a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "required": True or False, # Whether the field is required. The action button needs to stay disabled till values for all required fields are provided. + "textInput": { # Text input allows merchants to provide a text value. # Input field to provide text information. Corresponds to the [html input type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea). + "additionalInfo": { # Block of text that may contain a tooltip with more information. # Additional info regarding the field to be displayed to merchant. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip. + "simpleTooltipValue": "A String", # Value of the tooltip as a simple text. + "simpleValue": "A String", # Value of the message as a simple text. + "tooltipIconStyle": "A String", # The suggested type of an icon for tooltip, if a tooltip is present. + }, + "ariaLabel": "A String", # Text to be used as the [aria label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the input. + "formatInfo": "A String", # Information about the required format. If present, it should be shown close to the input field to help merchants to provide a correct value. For example: "VAT numbers should be in a format similar to SK9999999999" + "type": "A String", # Type of the text input + }, + }, + ], + "label": "A String", # Text value describing the intent for the action flow. It can be used as an input label if merchant needs to pick one of multiple flows. For example: "I disagree with the issue" + }, + ], + }, "buttonLabel": "A String", # Label of the action button. "externalAction": { # Action that is implemented and performed outside of the third-party application. It should redirect the merchant to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center. # Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the merchant to the external location where they can perform the action. "type": "A String", # The type of external action. @@ -252,4 +377,48 @@

Method Details

}
+
+ triggeraction(merchantId, body=None, languageCode=None, x__xgafv=None) +
Start an action. The action can be requested by merchants in third-party application. Before merchants can request the action, the third-party application needs to show them action specific content and display a user input form. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.
+
+Args:
+  merchantId: string, Required. The ID of the merchant's account. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The payload for the triggered action.
+  "actionContext": "A String", # Required. The context from the selected action. The value is obtained from rendered issues and needs to be sent back to identify the action that is being triggered.
+  "actionInput": { # Input provided by the merchant. # Required. Input provided by the merchant.
+    "actionFlowId": "A String", # Required. Id of the selected action flow.
+    "inputValues": [ # Required. Values for input fields.
+      { # Input provided by the merchant for input field.
+        "checkboxInputValue": { # Value for checkbox input field. # Value for checkbox input field.
+          "value": True or False, # Required. True if the merchant checked the box field. False otherwise.
+        },
+        "choiceInputValue": { # Value for choice input field. # Value for choice input field.
+          "choiceInputOptionId": "A String", # Required. Id of the option that was selected by the merchant.
+        },
+        "inputFieldId": "A String", # Required. Id of the corresponding input field.
+        "textInputValue": { # Value for text input field. # Value for text input field.
+          "value": "A String", # Required. Text provided by the merchant.
+        },
+      },
+    ],
+  },
+}
+
+  languageCode: string, Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response informing about the started action.
+  "message": "A String", # The message for merchant.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/content_v2_1.products.html b/docs/dyn/content_v2_1.products.html index 70fa0210f17..2b49a5ad8fa 100644 --- a/docs/dyn/content_v2_1.products.html +++ b/docs/dyn/content_v2_1.products.html @@ -331,6 +331,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -605,6 +613,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -885,6 +901,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -1140,6 +1164,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -1394,6 +1426,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -1660,6 +1700,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -1932,6 +1980,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. @@ -2186,6 +2242,14 @@

Method Details

"A String", ], "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. + "content": "A String", # Required. The description text. Maximum length is 5000 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, + "structuredTitle": { # Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information. # Structured title, for algorithmically (AI)-generated titles. + "content": "A String", # Required. The title text. Maximum length is 150 characters. + "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" + }, "subscriptionCost": { # Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. "amount": { # The amount the buyer has to pay per subscription period. "currency": "A String", # The currency of the price. diff --git a/docs/dyn/discoveryengine_v1alpha.locations.html b/docs/dyn/discoveryengine_v1alpha.locations.html index b7a6a108b20..7c206f9bdb9 100644 --- a/docs/dyn/discoveryengine_v1alpha.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.locations.html @@ -290,6 +290,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -564,7 +575,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. @@ -636,6 +647,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -730,7 +752,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", @@ -832,7 +854,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html index f88cf00daa5..2db35cbdbea 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.chunks.html @@ -123,7 +123,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. @@ -167,7 +167,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html index f6216154677..c02c0ea9db0 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html @@ -302,9 +302,9 @@

Method Details

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

Method Details

"projectId": "A String", # 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. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, - "bigtableSource": { # The Cloud Bigtable source for importing data # Cloud Bigtable input source. + "bigtableSource": { # The Cloud Bigtable source for importing data. # Cloud Bigtable input source. "bigtableOptions": { # The Bigtable Options object that contains information to support the import. # Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. "families": { # 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. - "a_key": { + "a_key": { # The column family of the Bigtable. "columns": [ # 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. - { - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. - "qualifier": "A String", # Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. - "type": "A String", # Optional. 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. + { # The column of the Bigtable. + "encoding": "A String", # 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. + "fieldName": "A String", # 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. + "qualifier": "A String", # Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. + "type": "A String", # 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`. }, ], - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. - "type": "A String", # Optional. 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. + "encoding": "A String", # 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. + "fieldName": "A String", # 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": "A String", # 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`. }, }, - "keyFieldName": "A String", # The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* + "keyFieldName": "A String", # The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. }, - "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be exported. - "projectId": "A String", # The project ID (can be project # or 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. - "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be exported. + "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be imported. + "projectId": "A String", # 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. + "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be imported. }, "cloudSqlSource": { # Cloud SQL source import data from. # Cloud SQL input source. "databaseId": "A String", # Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. - "offload": True or False, # Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "offload": True or False, # Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). + "projectId": "A String", # 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. "tableId": "A String", # Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. @@ -354,18 +354,18 @@

Method Details

"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. }, "firestoreSource": { # Firestore source import data from. # Firestore input source. - "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1500 characters. + "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. "databaseId": "A String", # Required. The Firestore database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "projectId": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], }, - "idField": "A String", # 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 + "idField": "A String", # 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. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. @@ -404,11 +404,12 @@

Method Details

"reconciliationMode": "A String", # The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. "spannerSource": { # The Spanner source for importing data # Spanner input source. "databaseId": "A String", # Required. The database ID of the source Spanner table. - "enableDataBoost": True or False, # Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas + "enableDataBoost": True or False, # 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). "instanceId": "A String", # Required. The instance ID of the source Spanner table. "projectId": "A String", # 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. "tableId": "A String", # Required. The table name of the Spanner database that needs to be imported. }, + "updateMask": "A String", # Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. } x__xgafv: string, V1 error format. @@ -608,7 +609,7 @@

Method Details

"filter": "A String", # Required. Filter matching documents to purge. Only currently supported value is `*` (all items). "force": True or False, # Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html index 5dffaf97606..67e0ff373b6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html @@ -118,6 +118,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -389,7 +400,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 6434a02d56d..abcbe4d5540 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -104,6 +104,11 @@

Instance Methods

Returns the servingConfigs Resource.

+

+ sessions() +

+

Returns the sessions Resource.

+

siteSearchEngine()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index 100afbb556d..5ff5e791dee 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -74,6 +74,9 @@

Discovery Engine API . projects . locations . collections . dataStores . servingConfigs

Instance Methods

+

+ answer(servingConfig, body=None, x__xgafv=None)

+

Answer query method.

close()

Close httplib2 connections.

@@ -99,6 +102,236 @@

Instance Methods

search_next()

Retrieves the next page of results.

Method Details

+
+ answer(servingConfig, body=None, x__xgafv=None) +
Answer query method.
+
+Args:
+  servingConfig: string, 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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+  "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+    "answerLanguageCode": "A String", # 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.
+    "ignoreAdversarialQuery": True or False, # 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.
+    "ignoreNonAnswerSeekingQuery": True or False, # 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.
+    "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+    "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+      "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+    },
+    "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+      "preamble": "A String", # Customized preamble.
+    },
+  },
+  "asynchronousMode": True or False, # 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": { # Defines a user inputed query. # Required. Current user query.
+    "queryId": "A String", # Unique Id for the query.
+    "text": "A String", # Plain text.
+  },
+  "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+    "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+      "types": [ # Enabled query classification types.
+        "A String",
+      ],
+    },
+    "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+      "disable": True or False, # Disable query rephraser.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.
+    },
+  },
+  "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+    "enable": True or False, # Enable related questions feature if true.
+  },
+  "safetySpec": { # Safety specification. # Model specification.
+    "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+  },
+  "searchSpec": { # Search specification. # Search specification.
+    "searchParams": { # Search parameters. # Search parameters.
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        "conditionBoostSpecs": [ # 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.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # 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.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # 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).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # 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).
+                  "attributeValue": "A String", # 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]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # 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": "A String", # 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)
+      "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+      "orderBy": "A String", # 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.
+      "searchResultMode": "A String", # 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)
+    },
+    "searchResultList": { # Search result list. # Search result list.
+      "searchResults": [ # Search results.
+        { # Search result.
+          "chunkInfo": { # Chunk information. # Chunk information.
+            "chunk": "A String", # Chunk resource name.
+            "content": "A String", # Chunk textual content.
+          },
+          "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+            "document": "A String", # Document resource name.
+            "documentContexts": [ # List of document contexts.
+              { # Document context.
+                "content": "A String", # Document content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveAnswers": [ # List of extractive answers.
+              { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+                "content": "A String", # Extractive answer content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveSegments": [ # List of extractive segments.
+              { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                "content": "A String", # Extractive segment content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+        },
+      ],
+    },
+  },
+  "session": "A String", # 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.
+  "userPseudoId": "A 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.AnswerQuery method.
+  "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+    "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+      "A String",
+    ],
+    "answerText": "A String", # The textual answer.
+    "citations": [ # Citations.
+      { # Citation info for a segment.
+        "endIndex": "A String", # End of the attributed segment, exclusive.
+        "sources": [ # Citation sources for the attributed segment.
+          { # Citation source.
+            "referenceId": "A String", # ID of the citation source.
+          },
+        ],
+        "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+      },
+    ],
+    "completeTime": "A String", # Output only. Answer completed timestamp.
+    "createTime": "A String", # Output only. Answer creation timestamp.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+    "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+      "queryClassificationInfo": [ # Query classification information.
+        { # Query classification information.
+          "positive": True or False, # Classification output.
+          "type": "A String", # Query classification type.
+        },
+      ],
+    },
+    "references": [ # References.
+      { # Reference.
+        "chunkInfo": { # Chunk information. # Chunk information.
+          "chunk": "A String", # Chunk resource name.
+          "content": "A String", # Chunk textual content.
+          "documentMetadata": { # Document metadata. # Document metadata.
+            "document": "A String", # Document resource name.
+            "pageIdentifier": "A String", # Page identifier.
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+          "relevanceScore": 3.14, # Relevance score.
+        },
+        "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+          "chunkContents": [ # List of cited chunk contents derived from document content.
+            { # Chunk content.
+              "content": "A String", # Chunk textual content.
+              "pageIdentifier": "A String", # Page identifier.
+            },
+          ],
+          "document": "A String", # Document resource name.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+      },
+    ],
+    "relatedQuestions": [ # Suggested related questions.
+      "A String",
+    ],
+    "state": "A String", # The state of the answer generation.
+    "steps": [ # Answer generation steps.
+      { # Step information.
+        "actions": [ # Actions.
+          { # Action.
+            "observation": { # Observation. # Observation.
+              "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+                {
+                  "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                    { # Chunk information.
+                      "chunk": "A String", # Chunk resource name.
+                      "content": "A String", # Chunk textual content.
+                      "relevanceScore": 3.14, # Relevance score.
+                    },
+                  ],
+                  "document": "A String", # Document resource name.
+                  "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                    { # Snippet information.
+                      "snippet": "A String", # Snippet content.
+                      "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                    },
+                  ],
+                  "title": "A String", # Title.
+                  "uri": "A String", # URI for the document.
+                },
+              ],
+            },
+            "searchAction": { # Search action. # Search action.
+              "query": "A String", # The query to search.
+            },
+          },
+        ],
+        "description": "A String", # The description of the step.
+        "state": "A String", # The state of the step.
+        "thought": "A String", # The thought of the step.
+      },
+    ],
+  },
+  "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+    "endTime": "A String", # Output only. The time the session finished.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+    "startTime": "A String", # Output only. The time the session started.
+    "state": "A String", # The state of the session.
+    "turns": [ # Turns.
+      { # Represents a turn, including a query from the user and a answer from service.
+        "answer": "A String", # The resource name of the answer to the user query.
+        "query": { # Defines a user inputed query. # The user query.
+          "queryId": "A String", # Unique Id for the query.
+          "text": "A String", # Plain text.
+        },
+      },
+    ],
+    "userPseudoId": "A String", # A unique identifier for tracking users.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -686,6 +919,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -780,7 +1024,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", @@ -880,7 +1124,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html new file mode 100644 index 00000000000..2668161ba8d --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . projects . locations . collections . dataStores . sessions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Answer.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a Answer.
+
+Args:
+  name: string, 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an answer.
+  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+    "A String",
+  ],
+  "answerText": "A String", # The textual answer.
+  "citations": [ # Citations.
+    { # Citation info for a segment.
+      "endIndex": "A String", # End of the attributed segment, exclusive.
+      "sources": [ # Citation sources for the attributed segment.
+        { # Citation source.
+          "referenceId": "A String", # ID of the citation source.
+        },
+      ],
+      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+    },
+  ],
+  "completeTime": "A String", # Output only. Answer completed timestamp.
+  "createTime": "A String", # Output only. Answer creation timestamp.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+    "queryClassificationInfo": [ # Query classification information.
+      { # Query classification information.
+        "positive": True or False, # Classification output.
+        "type": "A String", # Query classification type.
+      },
+    ],
+  },
+  "references": [ # References.
+    { # Reference.
+      "chunkInfo": { # Chunk information. # Chunk information.
+        "chunk": "A String", # Chunk resource name.
+        "content": "A String", # Chunk textual content.
+        "documentMetadata": { # Document metadata. # Document metadata.
+          "document": "A String", # Document resource name.
+          "pageIdentifier": "A String", # Page identifier.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+        "relevanceScore": 3.14, # Relevance score.
+      },
+      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+        "chunkContents": [ # List of cited chunk contents derived from document content.
+          { # Chunk content.
+            "content": "A String", # Chunk textual content.
+            "pageIdentifier": "A String", # Page identifier.
+          },
+        ],
+        "document": "A String", # Document resource name.
+        "title": "A String", # Title.
+        "uri": "A String", # URI for the document.
+      },
+    },
+  ],
+  "relatedQuestions": [ # Suggested related questions.
+    "A String",
+  ],
+  "state": "A String", # The state of the answer generation.
+  "steps": [ # Answer generation steps.
+    { # Step information.
+      "actions": [ # Actions.
+        { # Action.
+          "observation": { # Observation. # Observation.
+            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+              {
+                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                  { # Chunk information.
+                    "chunk": "A String", # Chunk resource name.
+                    "content": "A String", # Chunk textual content.
+                    "relevanceScore": 3.14, # Relevance score.
+                  },
+                ],
+                "document": "A String", # Document resource name.
+                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                  { # Snippet information.
+                    "snippet": "A String", # Snippet content.
+                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                  },
+                ],
+                "title": "A String", # Title.
+                "uri": "A String", # URI for the document.
+              },
+            ],
+          },
+          "searchAction": { # Search action. # Search action.
+            "query": "A String", # The query to search.
+          },
+        },
+      ],
+      "description": "A String", # The description of the step.
+      "state": "A String", # The state of the step.
+      "thought": "A String", # The thought of the step.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html new file mode 100644 index 00000000000..807bc2550e7 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html @@ -0,0 +1,319 @@ + + + +

Discovery Engine API . projects . locations . collections . dataStores . sessions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

+

+ delete(name, x__xgafv=None)

+

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

+

+ get(name, x__xgafv=None)

+

Gets a Session.

+

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

+

Lists all Sessions by their parent DataStore.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Session.
+
+Args:
+  name: 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)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Sessions by their parent DataStore.
+
+Args:
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+  orderBy: 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"
+  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+  pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListSessions method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "sessions": [ # All the Sessions for a given data store.
+    { # External session proto definition.
+      "endTime": "A String", # Output only. The time the session finished.
+      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+      "startTime": "A String", # Output only. The time the session started.
+      "state": "A String", # The state of the session.
+      "turns": [ # Turns.
+        { # Represents a turn, including a query from the user and a answer from service.
+          "answer": "A String", # The resource name of the answer to the user query.
+          "query": { # Defines a user inputed query. # The user query.
+            "queryId": "A String", # Unique Id for the query.
+            "text": "A String", # Plain text.
+          },
+        },
+      ],
+      "userPseudoId": "A String", # A unique identifier for tracking users.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.suggestionDenyListEntries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.suggestionDenyListEntries.html index fe03832ea09..02f870db06f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.suggestionDenyListEntries.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.suggestionDenyListEntries.html @@ -100,7 +100,7 @@

Method Details

{ # Request message for CompletionService.ImportSuggestionDenyListEntries method. "gcsSource": { # Cloud Storage location for input content. # 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. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html index 465fc472ae8..08b91c66427 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -134,7 +134,7 @@

Method Details

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

Method Details

"gcsPrefix": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html index b59db40688d..410eeaf5236 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.conversations.html @@ -118,6 +118,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -389,7 +400,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 6910954d116..eef3f73e804 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -89,6 +89,11 @@

Instance Methods

Returns the servingConfigs Resource.

+

+ sessions() +

+

Returns the sessions Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index fb860aa6081..0780aa4faae 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -74,6 +74,9 @@

Discovery Engine API . projects . locations . collections . engines . servingConfigs

Instance Methods

+

+ answer(servingConfig, body=None, x__xgafv=None)

+

Answer query method.

close()

Close httplib2 connections.

@@ -99,6 +102,236 @@

Instance Methods

search_next()

Retrieves the next page of results.

Method Details

+
+ answer(servingConfig, body=None, x__xgafv=None) +
Answer query method.
+
+Args:
+  servingConfig: string, 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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+  "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+    "answerLanguageCode": "A String", # 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.
+    "ignoreAdversarialQuery": True or False, # 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.
+    "ignoreNonAnswerSeekingQuery": True or False, # 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.
+    "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+    "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+      "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+    },
+    "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+      "preamble": "A String", # Customized preamble.
+    },
+  },
+  "asynchronousMode": True or False, # 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": { # Defines a user inputed query. # Required. Current user query.
+    "queryId": "A String", # Unique Id for the query.
+    "text": "A String", # Plain text.
+  },
+  "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+    "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+      "types": [ # Enabled query classification types.
+        "A String",
+      ],
+    },
+    "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+      "disable": True or False, # Disable query rephraser.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.
+    },
+  },
+  "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+    "enable": True or False, # Enable related questions feature if true.
+  },
+  "safetySpec": { # Safety specification. # Model specification.
+    "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+  },
+  "searchSpec": { # Search specification. # Search specification.
+    "searchParams": { # Search parameters. # Search parameters.
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        "conditionBoostSpecs": [ # 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.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # 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.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # 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).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # 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).
+                  "attributeValue": "A String", # 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]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # 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": "A String", # 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)
+      "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+      "orderBy": "A String", # 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.
+      "searchResultMode": "A String", # 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)
+    },
+    "searchResultList": { # Search result list. # Search result list.
+      "searchResults": [ # Search results.
+        { # Search result.
+          "chunkInfo": { # Chunk information. # Chunk information.
+            "chunk": "A String", # Chunk resource name.
+            "content": "A String", # Chunk textual content.
+          },
+          "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+            "document": "A String", # Document resource name.
+            "documentContexts": [ # List of document contexts.
+              { # Document context.
+                "content": "A String", # Document content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveAnswers": [ # List of extractive answers.
+              { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+                "content": "A String", # Extractive answer content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveSegments": [ # List of extractive segments.
+              { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                "content": "A String", # Extractive segment content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+        },
+      ],
+    },
+  },
+  "session": "A String", # 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.
+  "userPseudoId": "A 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.AnswerQuery method.
+  "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+    "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+      "A String",
+    ],
+    "answerText": "A String", # The textual answer.
+    "citations": [ # Citations.
+      { # Citation info for a segment.
+        "endIndex": "A String", # End of the attributed segment, exclusive.
+        "sources": [ # Citation sources for the attributed segment.
+          { # Citation source.
+            "referenceId": "A String", # ID of the citation source.
+          },
+        ],
+        "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+      },
+    ],
+    "completeTime": "A String", # Output only. Answer completed timestamp.
+    "createTime": "A String", # Output only. Answer creation timestamp.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+    "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+      "queryClassificationInfo": [ # Query classification information.
+        { # Query classification information.
+          "positive": True or False, # Classification output.
+          "type": "A String", # Query classification type.
+        },
+      ],
+    },
+    "references": [ # References.
+      { # Reference.
+        "chunkInfo": { # Chunk information. # Chunk information.
+          "chunk": "A String", # Chunk resource name.
+          "content": "A String", # Chunk textual content.
+          "documentMetadata": { # Document metadata. # Document metadata.
+            "document": "A String", # Document resource name.
+            "pageIdentifier": "A String", # Page identifier.
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+          "relevanceScore": 3.14, # Relevance score.
+        },
+        "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+          "chunkContents": [ # List of cited chunk contents derived from document content.
+            { # Chunk content.
+              "content": "A String", # Chunk textual content.
+              "pageIdentifier": "A String", # Page identifier.
+            },
+          ],
+          "document": "A String", # Document resource name.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+      },
+    ],
+    "relatedQuestions": [ # Suggested related questions.
+      "A String",
+    ],
+    "state": "A String", # The state of the answer generation.
+    "steps": [ # Answer generation steps.
+      { # Step information.
+        "actions": [ # Actions.
+          { # Action.
+            "observation": { # Observation. # Observation.
+              "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+                {
+                  "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                    { # Chunk information.
+                      "chunk": "A String", # Chunk resource name.
+                      "content": "A String", # Chunk textual content.
+                      "relevanceScore": 3.14, # Relevance score.
+                    },
+                  ],
+                  "document": "A String", # Document resource name.
+                  "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                    { # Snippet information.
+                      "snippet": "A String", # Snippet content.
+                      "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                    },
+                  ],
+                  "title": "A String", # Title.
+                  "uri": "A String", # URI for the document.
+                },
+              ],
+            },
+            "searchAction": { # Search action. # Search action.
+              "query": "A String", # The query to search.
+            },
+          },
+        ],
+        "description": "A String", # The description of the step.
+        "state": "A String", # The state of the step.
+        "thought": "A String", # The thought of the step.
+      },
+    ],
+  },
+  "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+    "endTime": "A String", # Output only. The time the session finished.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+    "startTime": "A String", # Output only. The time the session started.
+    "state": "A String", # The state of the session.
+    "turns": [ # Turns.
+      { # Represents a turn, including a query from the user and a answer from service.
+        "answer": "A String", # The resource name of the answer to the user query.
+        "query": { # Defines a user inputed query. # The user query.
+          "queryId": "A String", # Unique Id for the query.
+          "text": "A String", # Plain text.
+        },
+      },
+    ],
+    "userPseudoId": "A String", # A unique identifier for tracking users.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -686,6 +919,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -780,7 +1024,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", @@ -880,7 +1124,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html new file mode 100644 index 00000000000..12142271b52 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . projects . locations . collections . engines . sessions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Answer.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a Answer.
+
+Args:
+  name: string, 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an answer.
+  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+    "A String",
+  ],
+  "answerText": "A String", # The textual answer.
+  "citations": [ # Citations.
+    { # Citation info for a segment.
+      "endIndex": "A String", # End of the attributed segment, exclusive.
+      "sources": [ # Citation sources for the attributed segment.
+        { # Citation source.
+          "referenceId": "A String", # ID of the citation source.
+        },
+      ],
+      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+    },
+  ],
+  "completeTime": "A String", # Output only. Answer completed timestamp.
+  "createTime": "A String", # Output only. Answer creation timestamp.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+    "queryClassificationInfo": [ # Query classification information.
+      { # Query classification information.
+        "positive": True or False, # Classification output.
+        "type": "A String", # Query classification type.
+      },
+    ],
+  },
+  "references": [ # References.
+    { # Reference.
+      "chunkInfo": { # Chunk information. # Chunk information.
+        "chunk": "A String", # Chunk resource name.
+        "content": "A String", # Chunk textual content.
+        "documentMetadata": { # Document metadata. # Document metadata.
+          "document": "A String", # Document resource name.
+          "pageIdentifier": "A String", # Page identifier.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+        "relevanceScore": 3.14, # Relevance score.
+      },
+      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+        "chunkContents": [ # List of cited chunk contents derived from document content.
+          { # Chunk content.
+            "content": "A String", # Chunk textual content.
+            "pageIdentifier": "A String", # Page identifier.
+          },
+        ],
+        "document": "A String", # Document resource name.
+        "title": "A String", # Title.
+        "uri": "A String", # URI for the document.
+      },
+    },
+  ],
+  "relatedQuestions": [ # Suggested related questions.
+    "A String",
+  ],
+  "state": "A String", # The state of the answer generation.
+  "steps": [ # Answer generation steps.
+    { # Step information.
+      "actions": [ # Actions.
+        { # Action.
+          "observation": { # Observation. # Observation.
+            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+              {
+                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                  { # Chunk information.
+                    "chunk": "A String", # Chunk resource name.
+                    "content": "A String", # Chunk textual content.
+                    "relevanceScore": 3.14, # Relevance score.
+                  },
+                ],
+                "document": "A String", # Document resource name.
+                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                  { # Snippet information.
+                    "snippet": "A String", # Snippet content.
+                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                  },
+                ],
+                "title": "A String", # Title.
+                "uri": "A String", # URI for the document.
+              },
+            ],
+          },
+          "searchAction": { # Search action. # Search action.
+            "query": "A String", # The query to search.
+          },
+        },
+      ],
+      "description": "A String", # The description of the step.
+      "state": "A String", # The state of the step.
+      "thought": "A String", # The thought of the step.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html new file mode 100644 index 00000000000..0be0e1bf840 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html @@ -0,0 +1,319 @@ + + + +

Discovery Engine API . projects . locations . collections . engines . sessions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

+

+ delete(name, x__xgafv=None)

+

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

+

+ get(name, x__xgafv=None)

+

Gets a Session.

+

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

+

Lists all Sessions by their parent DataStore.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Session.
+
+Args:
+  name: 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)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Sessions by their parent DataStore.
+
+Args:
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+  orderBy: 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"
+  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+  pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListSessions method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "sessions": [ # All the Sessions for a given data store.
+    { # External session proto definition.
+      "endTime": "A String", # Output only. The time the session finished.
+      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+      "startTime": "A String", # Output only. The time the session started.
+      "state": "A String", # The state of the session.
+      "turns": [ # Turns.
+        { # Represents a turn, including a query from the user and a answer from service.
+          "answer": "A String", # The resource name of the answer to the user query.
+          "query": { # Defines a user inputed query. # The user query.
+            "queryId": "A String", # Unique Id for the query.
+            "text": "A String", # Plain text.
+          },
+        },
+      ],
+      "userPseudoId": "A String", # A unique identifier for tracking users.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html index dd2e4d7a8b3..da5a4585218 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.chunks.html @@ -123,7 +123,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. @@ -167,7 +167,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index 8373303694e..32b4a034a23 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -302,9 +302,9 @@

Method Details

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

Method Details

"projectId": "A String", # 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. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, - "bigtableSource": { # The Cloud Bigtable source for importing data # Cloud Bigtable input source. + "bigtableSource": { # The Cloud Bigtable source for importing data. # Cloud Bigtable input source. "bigtableOptions": { # The Bigtable Options object that contains information to support the import. # Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. "families": { # 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. - "a_key": { + "a_key": { # The column family of the Bigtable. "columns": [ # 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. - { - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. - "qualifier": "A String", # Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. - "type": "A String", # Optional. 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. + { # The column of the Bigtable. + "encoding": "A String", # 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. + "fieldName": "A String", # 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. + "qualifier": "A String", # Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. + "type": "A String", # 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`. }, ], - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. - "type": "A String", # Optional. 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. + "encoding": "A String", # 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. + "fieldName": "A String", # 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": "A String", # 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`. }, }, - "keyFieldName": "A String", # The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* + "keyFieldName": "A String", # The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. }, - "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be exported. - "projectId": "A String", # The project ID (can be project # or 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. - "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be exported. + "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be imported. + "projectId": "A String", # 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. + "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be imported. }, "cloudSqlSource": { # Cloud SQL source import data from. # Cloud SQL input source. "databaseId": "A String", # Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. - "offload": True or False, # Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "offload": True or False, # Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). + "projectId": "A String", # 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. "tableId": "A String", # Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. @@ -354,18 +354,18 @@

Method Details

"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. }, "firestoreSource": { # Firestore source import data from. # Firestore input source. - "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1500 characters. + "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. "databaseId": "A String", # Required. The Firestore database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "projectId": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], }, - "idField": "A String", # 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 + "idField": "A String", # 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. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. @@ -404,11 +404,12 @@

Method Details

"reconciliationMode": "A String", # The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. "spannerSource": { # The Spanner source for importing data # Spanner input source. "databaseId": "A String", # Required. The database ID of the source Spanner table. - "enableDataBoost": True or False, # Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas + "enableDataBoost": True or False, # 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). "instanceId": "A String", # Required. The instance ID of the source Spanner table. "projectId": "A String", # 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. "tableId": "A String", # Required. The table name of the Spanner database that needs to be imported. }, + "updateMask": "A String", # Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. } x__xgafv: string, V1 error format. @@ -608,7 +609,7 @@

Method Details

"filter": "A String", # Required. Filter matching documents to purge. Only currently supported value is `*` (all items). "force": True or False, # Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html index cb07c733607..b4355a5fe2d 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.conversations.html @@ -118,6 +118,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -389,7 +400,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 7bec1fc2618..b361d2e1d5b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -104,6 +104,11 @@

Instance Methods

Returns the servingConfigs Resource.

+

+ sessions() +

+

Returns the sessions Resource.

+

siteSearchEngine()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index b81c12d6827..52f53b4e4d5 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -74,6 +74,9 @@

Discovery Engine API . projects . locations . dataStores . servingConfigs

Instance Methods

+

+ answer(servingConfig, body=None, x__xgafv=None)

+

Answer query method.

close()

Close httplib2 connections.

@@ -99,6 +102,236 @@

Instance Methods

search_next()

Retrieves the next page of results.

Method Details

+
+ answer(servingConfig, body=None, x__xgafv=None) +
Answer query method.
+
+Args:
+  servingConfig: string, 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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+  "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+    "answerLanguageCode": "A String", # 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.
+    "ignoreAdversarialQuery": True or False, # 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.
+    "ignoreNonAnswerSeekingQuery": True or False, # 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.
+    "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+    "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+      "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+    },
+    "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+      "preamble": "A String", # Customized preamble.
+    },
+  },
+  "asynchronousMode": True or False, # 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": { # Defines a user inputed query. # Required. Current user query.
+    "queryId": "A String", # Unique Id for the query.
+    "text": "A String", # Plain text.
+  },
+  "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+    "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+      "types": [ # Enabled query classification types.
+        "A String",
+      ],
+    },
+    "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+      "disable": True or False, # Disable query rephraser.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.
+    },
+  },
+  "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+    "enable": True or False, # Enable related questions feature if true.
+  },
+  "safetySpec": { # Safety specification. # Model specification.
+    "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+  },
+  "searchSpec": { # Search specification. # Search specification.
+    "searchParams": { # Search parameters. # Search parameters.
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        "conditionBoostSpecs": [ # 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.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # 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.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # 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).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # 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).
+                  "attributeValue": "A String", # 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]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # 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": "A String", # 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)
+      "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+      "orderBy": "A String", # 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.
+      "searchResultMode": "A String", # 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)
+    },
+    "searchResultList": { # Search result list. # Search result list.
+      "searchResults": [ # Search results.
+        { # Search result.
+          "chunkInfo": { # Chunk information. # Chunk information.
+            "chunk": "A String", # Chunk resource name.
+            "content": "A String", # Chunk textual content.
+          },
+          "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+            "document": "A String", # Document resource name.
+            "documentContexts": [ # List of document contexts.
+              { # Document context.
+                "content": "A String", # Document content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveAnswers": [ # List of extractive answers.
+              { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+                "content": "A String", # Extractive answer content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveSegments": [ # List of extractive segments.
+              { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                "content": "A String", # Extractive segment content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+        },
+      ],
+    },
+  },
+  "session": "A String", # 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.
+  "userPseudoId": "A 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.AnswerQuery method.
+  "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+    "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+      "A String",
+    ],
+    "answerText": "A String", # The textual answer.
+    "citations": [ # Citations.
+      { # Citation info for a segment.
+        "endIndex": "A String", # End of the attributed segment, exclusive.
+        "sources": [ # Citation sources for the attributed segment.
+          { # Citation source.
+            "referenceId": "A String", # ID of the citation source.
+          },
+        ],
+        "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+      },
+    ],
+    "completeTime": "A String", # Output only. Answer completed timestamp.
+    "createTime": "A String", # Output only. Answer creation timestamp.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+    "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+      "queryClassificationInfo": [ # Query classification information.
+        { # Query classification information.
+          "positive": True or False, # Classification output.
+          "type": "A String", # Query classification type.
+        },
+      ],
+    },
+    "references": [ # References.
+      { # Reference.
+        "chunkInfo": { # Chunk information. # Chunk information.
+          "chunk": "A String", # Chunk resource name.
+          "content": "A String", # Chunk textual content.
+          "documentMetadata": { # Document metadata. # Document metadata.
+            "document": "A String", # Document resource name.
+            "pageIdentifier": "A String", # Page identifier.
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+          "relevanceScore": 3.14, # Relevance score.
+        },
+        "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+          "chunkContents": [ # List of cited chunk contents derived from document content.
+            { # Chunk content.
+              "content": "A String", # Chunk textual content.
+              "pageIdentifier": "A String", # Page identifier.
+            },
+          ],
+          "document": "A String", # Document resource name.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+      },
+    ],
+    "relatedQuestions": [ # Suggested related questions.
+      "A String",
+    ],
+    "state": "A String", # The state of the answer generation.
+    "steps": [ # Answer generation steps.
+      { # Step information.
+        "actions": [ # Actions.
+          { # Action.
+            "observation": { # Observation. # Observation.
+              "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+                {
+                  "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                    { # Chunk information.
+                      "chunk": "A String", # Chunk resource name.
+                      "content": "A String", # Chunk textual content.
+                      "relevanceScore": 3.14, # Relevance score.
+                    },
+                  ],
+                  "document": "A String", # Document resource name.
+                  "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                    { # Snippet information.
+                      "snippet": "A String", # Snippet content.
+                      "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                    },
+                  ],
+                  "title": "A String", # Title.
+                  "uri": "A String", # URI for the document.
+                },
+              ],
+            },
+            "searchAction": { # Search action. # Search action.
+              "query": "A String", # The query to search.
+            },
+          },
+        ],
+        "description": "A String", # The description of the step.
+        "state": "A String", # The state of the step.
+        "thought": "A String", # The thought of the step.
+      },
+    ],
+  },
+  "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+    "endTime": "A String", # Output only. The time the session finished.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+    "startTime": "A String", # Output only. The time the session started.
+    "state": "A String", # The state of the session.
+    "turns": [ # Turns.
+      { # Represents a turn, including a query from the user and a answer from service.
+        "answer": "A String", # The resource name of the answer to the user query.
+        "query": { # Defines a user inputed query. # The user query.
+          "queryId": "A String", # Unique Id for the query.
+          "text": "A String", # Plain text.
+        },
+      },
+    ],
+    "userPseudoId": "A String", # A unique identifier for tracking users.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -686,6 +919,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -780,7 +1024,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", @@ -880,7 +1124,7 @@

Method Details

"title": "A String", # Title of the document. "uri": "A String", # Uri of the document. }, - "id": "A String", # Unique chunk id of the current chunk. + "id": "A String", # Unique chunk ID of the current chunk. "name": "A String", # 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. "pageSpan": { # Page span of the chunk. # Page span of the chunk. "pageEnd": 42, # The end page of the chunk. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html new file mode 100644 index 00000000000..0e55288810a --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . projects . locations . dataStores . sessions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Answer.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a Answer.
+
+Args:
+  name: string, 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an answer.
+  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+    "A String",
+  ],
+  "answerText": "A String", # The textual answer.
+  "citations": [ # Citations.
+    { # Citation info for a segment.
+      "endIndex": "A String", # End of the attributed segment, exclusive.
+      "sources": [ # Citation sources for the attributed segment.
+        { # Citation source.
+          "referenceId": "A String", # ID of the citation source.
+        },
+      ],
+      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+    },
+  ],
+  "completeTime": "A String", # Output only. Answer completed timestamp.
+  "createTime": "A String", # Output only. Answer creation timestamp.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+    "queryClassificationInfo": [ # Query classification information.
+      { # Query classification information.
+        "positive": True or False, # Classification output.
+        "type": "A String", # Query classification type.
+      },
+    ],
+  },
+  "references": [ # References.
+    { # Reference.
+      "chunkInfo": { # Chunk information. # Chunk information.
+        "chunk": "A String", # Chunk resource name.
+        "content": "A String", # Chunk textual content.
+        "documentMetadata": { # Document metadata. # Document metadata.
+          "document": "A String", # Document resource name.
+          "pageIdentifier": "A String", # Page identifier.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+        "relevanceScore": 3.14, # Relevance score.
+      },
+      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+        "chunkContents": [ # List of cited chunk contents derived from document content.
+          { # Chunk content.
+            "content": "A String", # Chunk textual content.
+            "pageIdentifier": "A String", # Page identifier.
+          },
+        ],
+        "document": "A String", # Document resource name.
+        "title": "A String", # Title.
+        "uri": "A String", # URI for the document.
+      },
+    },
+  ],
+  "relatedQuestions": [ # Suggested related questions.
+    "A String",
+  ],
+  "state": "A String", # The state of the answer generation.
+  "steps": [ # Answer generation steps.
+    { # Step information.
+      "actions": [ # Actions.
+        { # Action.
+          "observation": { # Observation. # Observation.
+            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+              {
+                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                  { # Chunk information.
+                    "chunk": "A String", # Chunk resource name.
+                    "content": "A String", # Chunk textual content.
+                    "relevanceScore": 3.14, # Relevance score.
+                  },
+                ],
+                "document": "A String", # Document resource name.
+                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                  { # Snippet information.
+                    "snippet": "A String", # Snippet content.
+                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                  },
+                ],
+                "title": "A String", # Title.
+                "uri": "A String", # URI for the document.
+              },
+            ],
+          },
+          "searchAction": { # Search action. # Search action.
+            "query": "A String", # The query to search.
+          },
+        },
+      ],
+      "description": "A String", # The description of the step.
+      "state": "A String", # The state of the step.
+      "thought": "A String", # The thought of the step.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html new file mode 100644 index 00000000000..595f98aeec5 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.html @@ -0,0 +1,319 @@ + + + +

Discovery Engine API . projects . locations . dataStores . sessions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

+

+ delete(name, x__xgafv=None)

+

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

+

+ get(name, x__xgafv=None)

+

Gets a Session.

+

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

+

Lists all Sessions by their parent DataStore.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Session.
+
+Args:
+  name: 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)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Sessions by their parent DataStore.
+
+Args:
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+  orderBy: 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"
+  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+  pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListSessions method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "sessions": [ # All the Sessions for a given data store.
+    { # External session proto definition.
+      "endTime": "A String", # Output only. The time the session finished.
+      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+      "startTime": "A String", # Output only. The time the session started.
+      "state": "A String", # The state of the session.
+      "turns": [ # Turns.
+        { # Represents a turn, including a query from the user and a answer from service.
+          "answer": "A String", # The resource name of the answer to the user query.
+          "query": { # Defines a user inputed query. # The user query.
+            "queryId": "A String", # Unique Id for the query.
+            "text": "A String", # Plain text.
+          },
+        },
+      ],
+      "userPseudoId": "A String", # A unique identifier for tracking users.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.suggestionDenyListEntries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.suggestionDenyListEntries.html index c28eb2c3011..6434330b844 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.suggestionDenyListEntries.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.suggestionDenyListEntries.html @@ -100,7 +100,7 @@

Method Details

{ # Request message for CompletionService.ImportSuggestionDenyListEntries method. "gcsSource": { # Cloud Storage location for input content. # 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. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html index f870c94ab36..abf8d8607db 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -134,7 +134,7 @@

Method Details

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

Method Details

"gcsPrefix": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html new file mode 100644 index 00000000000..4fd237b35d4 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . evaluations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.operations.html new file mode 100644 index 00000000000..d066ce6d056 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.operations.html @@ -0,0 +1,124 @@ + + + +

Discovery Engine API . projects . locations . evaluations . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

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.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, 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`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html new file mode 100644 index 00000000000..9851b14cb09 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html @@ -0,0 +1,145 @@ + + + +

Discovery Engine API . projects . locations . groundingConfigs

+

Instance Methods

+

+ check(groundingConfig, body=None, x__xgafv=None)

+

Performs a grounding check.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ check(groundingConfig, body=None, x__xgafv=None) +
Performs a grounding check.
+
+Args:
+  groundingConfig: string, Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GroundedGenerationService.CheckGrounding method.
+  "answerCandidate": "A String", # Answer candidate to check.
+  "facts": [ # List of facts for the grounding check. We support up to 200 facts.
+    { # Grounding Fact.
+      "attributes": { # 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.
+        "a_key": "A String",
+      },
+      "factText": "A String", # Text content of the fact. Can be at most 10K characters long.
+    },
+  ],
+  "groundingSpec": { # Specification for the grounding check. # Configuration of the grounding check.
+    "citationThreshold": 3.14, # 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.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the GroundedGenerationService.CheckGrounding method.
+  "citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
+    { # Fact Chunk.
+      "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long.
+      "source": "A String", # 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.
+      "sourceMetadata": { # More fine-grained information for the source reference.
+        "a_key": "A String",
+      },
+    },
+  ],
+  "claims": [ # Claim texts and citation info across all claims in the answer candidate.
+    { # Text and citation info for a claim in the answer candidate.
+      "citationIndices": [ # 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.
+        42,
+      ],
+      "claimText": "A String", # Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
+      "endPos": 42, # Position indicating the end of the claim in the answer candidate, exclusive.
+      "startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes/unicode.
+    },
+  ],
+  "supportScore": 3.14, # 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.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index da26113633c..e3d76047b03 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -84,6 +84,16 @@

Instance Methods

Returns the dataStores Resource.

+

+ evaluations() +

+

Returns the evaluations Resource.

+ +

+ groundingConfigs() +

+

Returns the groundingConfigs Resource.

+

operations()

@@ -124,7 +134,7 @@

Method Details

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

Method Details

"tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.rankingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.rankingConfigs.html index 2be33504e7e..c541f248153 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.rankingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.rankingConfigs.html @@ -99,7 +99,7 @@

Method Details

"ignoreRecordDetailsInResponse": True or False, # If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. "model": "A String", # 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. "query": "A String", # The query to use. - "records": [ # Required. A list of records to rank. + "records": [ # Required. A list of records to rank. At most 100 records to rank. { # Record message for RankService.Rank method. "content": "A String", # 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. "id": "A String", # The unique ID to represent the record. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index 0244fa4502f..a7f9191599c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html @@ -229,9 +229,9 @@

Method Details

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

Method Details

"projectId": "A String", # 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. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, - "bigtableSource": { # The Cloud Bigtable source for importing data # Cloud Bigtable input source. + "bigtableSource": { # The Cloud Bigtable source for importing data. # Cloud Bigtable input source. "bigtableOptions": { # The Bigtable Options object that contains information to support the import. # Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. "families": { # 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. - "a_key": { + "a_key": { # The column family of the Bigtable. "columns": [ # 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. - { - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. - "qualifier": "A String", # Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. - "type": "A String", # Optional. 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. + { # The column of the Bigtable. + "encoding": "A String", # 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. + "fieldName": "A String", # 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. + "qualifier": "A String", # Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. + "type": "A String", # 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`. }, ], - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. - "type": "A String", # Optional. 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. + "encoding": "A String", # 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. + "fieldName": "A String", # 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": "A String", # 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`. }, }, - "keyFieldName": "A String", # The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* + "keyFieldName": "A String", # The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. }, - "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be exported. - "projectId": "A String", # The project ID (can be project # or 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. - "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be exported. + "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be imported. + "projectId": "A String", # 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. + "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be imported. }, "cloudSqlSource": { # Cloud SQL source import data from. # Cloud SQL input source. "databaseId": "A String", # Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. - "offload": True or False, # Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "offload": True or False, # Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). + "projectId": "A String", # 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. "tableId": "A String", # Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. @@ -281,18 +281,18 @@

Method Details

"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. }, "firestoreSource": { # Firestore source import data from. # Firestore input source. - "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1500 characters. + "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. "databaseId": "A String", # Required. The Firestore database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "projectId": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], }, - "idField": "A String", # 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 + "idField": "A String", # 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. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. @@ -319,11 +319,12 @@

Method Details

"reconciliationMode": "A String", # The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. "spannerSource": { # The Spanner source for importing data # Spanner input source. "databaseId": "A String", # Required. The database ID of the source Spanner table. - "enableDataBoost": True or False, # Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas + "enableDataBoost": True or False, # 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). "instanceId": "A String", # Required. The instance ID of the source Spanner table. "projectId": "A String", # 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. "tableId": "A String", # Required. The table name of the Spanner database that needs to be imported. }, + "updateMask": "A String", # Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html index 2d8d4e15af8..7de546190be 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.conversations.html @@ -118,6 +118,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index f277e4ac89a..b245d1f4b4f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -104,6 +104,11 @@

Instance Methods

Returns the servingConfigs Resource.

+

+ sessions() +

+

Returns the sessions Resource.

+

siteSearchEngine()

diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index 3110214f98b..0674dccfa4b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -74,6 +74,9 @@

Discovery Engine API . projects . locations . collections . dataStores . servingConfigs

Instance Methods

+

+ answer(servingConfig, body=None, x__xgafv=None)

+

Answer query method.

close()

Close httplib2 connections.

@@ -99,6 +102,235 @@

Instance Methods

search_next()

Retrieves the next page of results.

Method Details

+
+ answer(servingConfig, body=None, x__xgafv=None) +
Answer query method.
+
+Args:
+  servingConfig: string, 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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+  "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+    "answerLanguageCode": "A String", # 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.
+    "ignoreAdversarialQuery": True or False, # 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.
+    "ignoreNonAnswerSeekingQuery": True or False, # 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.
+    "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+    "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+      "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+    },
+    "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+      "preamble": "A String", # Customized preamble.
+    },
+  },
+  "asynchronousMode": True or False, # 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": { # Defines a user inputed query. # Required. Current user query.
+    "queryId": "A String", # Unique Id for the query.
+    "text": "A String", # Plain text.
+  },
+  "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+    "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+      "types": [ # Enabled query classification types.
+        "A String",
+      ],
+    },
+    "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+      "disable": True or False, # Disable query rephraser.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.
+    },
+  },
+  "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+    "enable": True or False, # Enable related questions feature if true.
+  },
+  "safetySpec": { # Safety specification. # Model specification.
+    "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+  },
+  "searchSpec": { # Search specification. # Search specification.
+    "searchParams": { # Search parameters. # Search parameters.
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        "conditionBoostSpecs": [ # 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.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # 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.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # 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).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # 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).
+                  "attributeValue": "A String", # 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]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # 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": "A String", # 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)
+      "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+      "orderBy": "A String", # 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.
+    },
+    "searchResultList": { # Search result list. # Search result list.
+      "searchResults": [ # Search results.
+        { # Search result.
+          "chunkInfo": { # Chunk information. # Chunk information.
+            "chunk": "A String", # Chunk resource name.
+            "content": "A String", # Chunk textual content.
+          },
+          "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+            "document": "A String", # Document resource name.
+            "documentContexts": [ # List of document contexts.
+              { # Document context.
+                "content": "A String", # Document content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveAnswers": [ # List of extractive answers.
+              { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+                "content": "A String", # Extractive answer content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveSegments": [ # List of extractive segments.
+              { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                "content": "A String", # Extractive segment content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+        },
+      ],
+    },
+  },
+  "session": "A String", # 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.
+  "userPseudoId": "A 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.AnswerQuery method.
+  "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+    "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+      "A String",
+    ],
+    "answerText": "A String", # The textual answer.
+    "citations": [ # Citations.
+      { # Citation info for a segment.
+        "endIndex": "A String", # End of the attributed segment, exclusive.
+        "sources": [ # Citation sources for the attributed segment.
+          { # Citation source.
+            "referenceId": "A String", # ID of the citation source.
+          },
+        ],
+        "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+      },
+    ],
+    "completeTime": "A String", # Output only. Answer completed timestamp.
+    "createTime": "A String", # Output only. Answer creation timestamp.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+    "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+      "queryClassificationInfo": [ # Query classification information.
+        { # Query classification information.
+          "positive": True or False, # Classification output.
+          "type": "A String", # Query classification type.
+        },
+      ],
+    },
+    "references": [ # References.
+      { # Reference.
+        "chunkInfo": { # Chunk information. # Chunk information.
+          "chunk": "A String", # Chunk resource name.
+          "content": "A String", # Chunk textual content.
+          "documentMetadata": { # Document metadata. # Document metadata.
+            "document": "A String", # Document resource name.
+            "pageIdentifier": "A String", # Page identifier.
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+          "relevanceScore": 3.14, # Relevance score.
+        },
+        "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+          "chunkContents": [ # List of cited chunk contents derived from document content.
+            { # Chunk content.
+              "content": "A String", # Chunk textual content.
+              "pageIdentifier": "A String", # Page identifier.
+            },
+          ],
+          "document": "A String", # Document resource name.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+      },
+    ],
+    "relatedQuestions": [ # Suggested related questions.
+      "A String",
+    ],
+    "state": "A String", # The state of the answer generation.
+    "steps": [ # Answer generation steps.
+      { # Step information.
+        "actions": [ # Actions.
+          { # Action.
+            "observation": { # Observation. # Observation.
+              "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+                {
+                  "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                    { # Chunk information.
+                      "chunk": "A String", # Chunk resource name.
+                      "content": "A String", # Chunk textual content.
+                      "relevanceScore": 3.14, # Relevance score.
+                    },
+                  ],
+                  "document": "A String", # Document resource name.
+                  "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                    { # Snippet information.
+                      "snippet": "A String", # Snippet content.
+                      "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                    },
+                  ],
+                  "title": "A String", # Title.
+                  "uri": "A String", # URI for the document.
+                },
+              ],
+            },
+            "searchAction": { # Search action. # Search action.
+              "query": "A String", # The query to search.
+            },
+          },
+        ],
+        "description": "A String", # The description of the step.
+        "state": "A String", # The state of the step.
+        "thought": "A String", # The thought of the step.
+      },
+    ],
+  },
+  "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+    "endTime": "A String", # Output only. The time the session finished.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+    "startTime": "A String", # Output only. The time the session started.
+    "state": "A String", # The state of the session.
+    "turns": [ # Turns.
+      { # Represents a turn, including a query from the user and a answer from service.
+        "answer": "A String", # The resource name of the answer to the user query.
+        "query": { # Defines a user inputed query. # The user query.
+          "queryId": "A String", # Unique Id for the query.
+          "text": "A String", # Plain text.
+        },
+      },
+    ],
+    "userPseudoId": "A String", # A unique identifier for tracking users.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -622,6 +854,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -708,7 +951,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html new file mode 100644 index 00000000000..a7dfcba062f --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . projects . locations . collections . dataStores . sessions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Answer.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a Answer.
+
+Args:
+  name: string, 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an answer.
+  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+    "A String",
+  ],
+  "answerText": "A String", # The textual answer.
+  "citations": [ # Citations.
+    { # Citation info for a segment.
+      "endIndex": "A String", # End of the attributed segment, exclusive.
+      "sources": [ # Citation sources for the attributed segment.
+        { # Citation source.
+          "referenceId": "A String", # ID of the citation source.
+        },
+      ],
+      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+    },
+  ],
+  "completeTime": "A String", # Output only. Answer completed timestamp.
+  "createTime": "A String", # Output only. Answer creation timestamp.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+    "queryClassificationInfo": [ # Query classification information.
+      { # Query classification information.
+        "positive": True or False, # Classification output.
+        "type": "A String", # Query classification type.
+      },
+    ],
+  },
+  "references": [ # References.
+    { # Reference.
+      "chunkInfo": { # Chunk information. # Chunk information.
+        "chunk": "A String", # Chunk resource name.
+        "content": "A String", # Chunk textual content.
+        "documentMetadata": { # Document metadata. # Document metadata.
+          "document": "A String", # Document resource name.
+          "pageIdentifier": "A String", # Page identifier.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+        "relevanceScore": 3.14, # Relevance score.
+      },
+      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+        "chunkContents": [ # List of cited chunk contents derived from document content.
+          { # Chunk content.
+            "content": "A String", # Chunk textual content.
+            "pageIdentifier": "A String", # Page identifier.
+          },
+        ],
+        "document": "A String", # Document resource name.
+        "title": "A String", # Title.
+        "uri": "A String", # URI for the document.
+      },
+    },
+  ],
+  "relatedQuestions": [ # Suggested related questions.
+    "A String",
+  ],
+  "state": "A String", # The state of the answer generation.
+  "steps": [ # Answer generation steps.
+    { # Step information.
+      "actions": [ # Actions.
+        { # Action.
+          "observation": { # Observation. # Observation.
+            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+              {
+                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                  { # Chunk information.
+                    "chunk": "A String", # Chunk resource name.
+                    "content": "A String", # Chunk textual content.
+                    "relevanceScore": 3.14, # Relevance score.
+                  },
+                ],
+                "document": "A String", # Document resource name.
+                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                  { # Snippet information.
+                    "snippet": "A String", # Snippet content.
+                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                  },
+                ],
+                "title": "A String", # Title.
+                "uri": "A String", # URI for the document.
+              },
+            ],
+          },
+          "searchAction": { # Search action. # Search action.
+            "query": "A String", # The query to search.
+          },
+        },
+      ],
+      "description": "A String", # The description of the step.
+      "state": "A String", # The state of the step.
+      "thought": "A String", # The thought of the step.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html new file mode 100644 index 00000000000..d05041282c7 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html @@ -0,0 +1,319 @@ + + + +

Discovery Engine API . projects . locations . collections . dataStores . sessions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

+

+ delete(name, x__xgafv=None)

+

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

+

+ get(name, x__xgafv=None)

+

Gets a Session.

+

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

+

Lists all Sessions by their parent DataStore.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Session.
+
+Args:
+  name: 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)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Sessions by their parent DataStore.
+
+Args:
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+  orderBy: 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"
+  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+  pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListSessions method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "sessions": [ # All the Sessions for a given data store.
+    { # External session proto definition.
+      "endTime": "A String", # Output only. The time the session finished.
+      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+      "startTime": "A String", # Output only. The time the session started.
+      "state": "A String", # The state of the session.
+      "turns": [ # Turns.
+        { # Represents a turn, including a query from the user and a answer from service.
+          "answer": "A String", # The resource name of the answer to the user query.
+          "query": { # Defines a user inputed query. # The user query.
+            "queryId": "A String", # Unique Id for the query.
+            "text": "A String", # Plain text.
+          },
+        },
+      ],
+      "userPseudoId": "A String", # A unique identifier for tracking users.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.suggestionDenyListEntries.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.suggestionDenyListEntries.html index 788aa15b926..7cba449bb87 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.suggestionDenyListEntries.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.suggestionDenyListEntries.html @@ -100,7 +100,7 @@

Method Details

{ # Request message for CompletionService.ImportSuggestionDenyListEntries method. "gcsSource": { # Cloud Storage location for input content. # 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. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html index 00d2c620b65..fe949f9cb48 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -131,7 +131,7 @@

Method Details

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

Method Details

"gcsPrefix": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html index 6e4409c9c4f..bb598bcd82b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.conversations.html @@ -118,6 +118,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 6cb1f16e42b..f5b54ab861c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -89,6 +89,11 @@

Instance Methods

Returns the servingConfigs Resource.

+

+ sessions() +

+

Returns the sessions Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 7096727e744..ce24abfe4f5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -74,6 +74,9 @@

Discovery Engine API . projects . locations . collections . engines . servingConfigs

Instance Methods

+

+ answer(servingConfig, body=None, x__xgafv=None)

+

Answer query method.

close()

Close httplib2 connections.

@@ -99,6 +102,235 @@

Instance Methods

search_next()

Retrieves the next page of results.

Method Details

+
+ answer(servingConfig, body=None, x__xgafv=None) +
Answer query method.
+
+Args:
+  servingConfig: string, 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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+  "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+    "answerLanguageCode": "A String", # 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.
+    "ignoreAdversarialQuery": True or False, # 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.
+    "ignoreNonAnswerSeekingQuery": True or False, # 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.
+    "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+    "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+      "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+    },
+    "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+      "preamble": "A String", # Customized preamble.
+    },
+  },
+  "asynchronousMode": True or False, # 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": { # Defines a user inputed query. # Required. Current user query.
+    "queryId": "A String", # Unique Id for the query.
+    "text": "A String", # Plain text.
+  },
+  "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+    "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+      "types": [ # Enabled query classification types.
+        "A String",
+      ],
+    },
+    "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+      "disable": True or False, # Disable query rephraser.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.
+    },
+  },
+  "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+    "enable": True or False, # Enable related questions feature if true.
+  },
+  "safetySpec": { # Safety specification. # Model specification.
+    "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+  },
+  "searchSpec": { # Search specification. # Search specification.
+    "searchParams": { # Search parameters. # Search parameters.
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        "conditionBoostSpecs": [ # 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.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # 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.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # 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).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # 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).
+                  "attributeValue": "A String", # 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]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # 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": "A String", # 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)
+      "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+      "orderBy": "A String", # 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.
+    },
+    "searchResultList": { # Search result list. # Search result list.
+      "searchResults": [ # Search results.
+        { # Search result.
+          "chunkInfo": { # Chunk information. # Chunk information.
+            "chunk": "A String", # Chunk resource name.
+            "content": "A String", # Chunk textual content.
+          },
+          "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+            "document": "A String", # Document resource name.
+            "documentContexts": [ # List of document contexts.
+              { # Document context.
+                "content": "A String", # Document content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveAnswers": [ # List of extractive answers.
+              { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+                "content": "A String", # Extractive answer content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveSegments": [ # List of extractive segments.
+              { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                "content": "A String", # Extractive segment content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+        },
+      ],
+    },
+  },
+  "session": "A String", # 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.
+  "userPseudoId": "A 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.AnswerQuery method.
+  "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+    "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+      "A String",
+    ],
+    "answerText": "A String", # The textual answer.
+    "citations": [ # Citations.
+      { # Citation info for a segment.
+        "endIndex": "A String", # End of the attributed segment, exclusive.
+        "sources": [ # Citation sources for the attributed segment.
+          { # Citation source.
+            "referenceId": "A String", # ID of the citation source.
+          },
+        ],
+        "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+      },
+    ],
+    "completeTime": "A String", # Output only. Answer completed timestamp.
+    "createTime": "A String", # Output only. Answer creation timestamp.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+    "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+      "queryClassificationInfo": [ # Query classification information.
+        { # Query classification information.
+          "positive": True or False, # Classification output.
+          "type": "A String", # Query classification type.
+        },
+      ],
+    },
+    "references": [ # References.
+      { # Reference.
+        "chunkInfo": { # Chunk information. # Chunk information.
+          "chunk": "A String", # Chunk resource name.
+          "content": "A String", # Chunk textual content.
+          "documentMetadata": { # Document metadata. # Document metadata.
+            "document": "A String", # Document resource name.
+            "pageIdentifier": "A String", # Page identifier.
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+          "relevanceScore": 3.14, # Relevance score.
+        },
+        "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+          "chunkContents": [ # List of cited chunk contents derived from document content.
+            { # Chunk content.
+              "content": "A String", # Chunk textual content.
+              "pageIdentifier": "A String", # Page identifier.
+            },
+          ],
+          "document": "A String", # Document resource name.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+      },
+    ],
+    "relatedQuestions": [ # Suggested related questions.
+      "A String",
+    ],
+    "state": "A String", # The state of the answer generation.
+    "steps": [ # Answer generation steps.
+      { # Step information.
+        "actions": [ # Actions.
+          { # Action.
+            "observation": { # Observation. # Observation.
+              "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+                {
+                  "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                    { # Chunk information.
+                      "chunk": "A String", # Chunk resource name.
+                      "content": "A String", # Chunk textual content.
+                      "relevanceScore": 3.14, # Relevance score.
+                    },
+                  ],
+                  "document": "A String", # Document resource name.
+                  "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                    { # Snippet information.
+                      "snippet": "A String", # Snippet content.
+                      "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                    },
+                  ],
+                  "title": "A String", # Title.
+                  "uri": "A String", # URI for the document.
+                },
+              ],
+            },
+            "searchAction": { # Search action. # Search action.
+              "query": "A String", # The query to search.
+            },
+          },
+        ],
+        "description": "A String", # The description of the step.
+        "state": "A String", # The state of the step.
+        "thought": "A String", # The thought of the step.
+      },
+    ],
+  },
+  "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+    "endTime": "A String", # Output only. The time the session finished.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+    "startTime": "A String", # Output only. The time the session started.
+    "state": "A String", # The state of the session.
+    "turns": [ # Turns.
+      { # Represents a turn, including a query from the user and a answer from service.
+        "answer": "A String", # The resource name of the answer to the user query.
+        "query": { # Defines a user inputed query. # The user query.
+          "queryId": "A String", # Unique Id for the query.
+          "text": "A String", # Plain text.
+        },
+      },
+    ],
+    "userPseudoId": "A String", # A unique identifier for tracking users.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -622,6 +854,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -708,7 +951,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html new file mode 100644 index 00000000000..a80f11e4b93 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . projects . locations . collections . engines . sessions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Answer.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a Answer.
+
+Args:
+  name: string, 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an answer.
+  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+    "A String",
+  ],
+  "answerText": "A String", # The textual answer.
+  "citations": [ # Citations.
+    { # Citation info for a segment.
+      "endIndex": "A String", # End of the attributed segment, exclusive.
+      "sources": [ # Citation sources for the attributed segment.
+        { # Citation source.
+          "referenceId": "A String", # ID of the citation source.
+        },
+      ],
+      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+    },
+  ],
+  "completeTime": "A String", # Output only. Answer completed timestamp.
+  "createTime": "A String", # Output only. Answer creation timestamp.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+    "queryClassificationInfo": [ # Query classification information.
+      { # Query classification information.
+        "positive": True or False, # Classification output.
+        "type": "A String", # Query classification type.
+      },
+    ],
+  },
+  "references": [ # References.
+    { # Reference.
+      "chunkInfo": { # Chunk information. # Chunk information.
+        "chunk": "A String", # Chunk resource name.
+        "content": "A String", # Chunk textual content.
+        "documentMetadata": { # Document metadata. # Document metadata.
+          "document": "A String", # Document resource name.
+          "pageIdentifier": "A String", # Page identifier.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+        "relevanceScore": 3.14, # Relevance score.
+      },
+      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+        "chunkContents": [ # List of cited chunk contents derived from document content.
+          { # Chunk content.
+            "content": "A String", # Chunk textual content.
+            "pageIdentifier": "A String", # Page identifier.
+          },
+        ],
+        "document": "A String", # Document resource name.
+        "title": "A String", # Title.
+        "uri": "A String", # URI for the document.
+      },
+    },
+  ],
+  "relatedQuestions": [ # Suggested related questions.
+    "A String",
+  ],
+  "state": "A String", # The state of the answer generation.
+  "steps": [ # Answer generation steps.
+    { # Step information.
+      "actions": [ # Actions.
+        { # Action.
+          "observation": { # Observation. # Observation.
+            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+              {
+                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                  { # Chunk information.
+                    "chunk": "A String", # Chunk resource name.
+                    "content": "A String", # Chunk textual content.
+                    "relevanceScore": 3.14, # Relevance score.
+                  },
+                ],
+                "document": "A String", # Document resource name.
+                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                  { # Snippet information.
+                    "snippet": "A String", # Snippet content.
+                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                  },
+                ],
+                "title": "A String", # Title.
+                "uri": "A String", # URI for the document.
+              },
+            ],
+          },
+          "searchAction": { # Search action. # Search action.
+            "query": "A String", # The query to search.
+          },
+        },
+      ],
+      "description": "A String", # The description of the step.
+      "state": "A String", # The state of the step.
+      "thought": "A String", # The thought of the step.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html new file mode 100644 index 00000000000..c1509bf96c1 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html @@ -0,0 +1,319 @@ + + + +

Discovery Engine API . projects . locations . collections . engines . sessions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

+

+ delete(name, x__xgafv=None)

+

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

+

+ get(name, x__xgafv=None)

+

Gets a Session.

+

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

+

Lists all Sessions by their parent DataStore.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Session.
+
+Args:
+  name: 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)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Sessions by their parent DataStore.
+
+Args:
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+  orderBy: 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"
+  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+  pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListSessions method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "sessions": [ # All the Sessions for a given data store.
+    { # External session proto definition.
+      "endTime": "A String", # Output only. The time the session finished.
+      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+      "startTime": "A String", # Output only. The time the session started.
+      "state": "A String", # The state of the session.
+      "turns": [ # Turns.
+        { # Represents a turn, including a query from the user and a answer from service.
+          "answer": "A String", # The resource name of the answer to the user query.
+          "query": { # Defines a user inputed query. # The user query.
+            "queryId": "A String", # Unique Id for the query.
+            "text": "A String", # Plain text.
+          },
+        },
+      ],
+      "userPseudoId": "A String", # A unique identifier for tracking users.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index 667cfd95c03..370cbd5c8cf 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -229,9 +229,9 @@

Method Details

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

Method Details

"projectId": "A String", # 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. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, - "bigtableSource": { # The Cloud Bigtable source for importing data # Cloud Bigtable input source. + "bigtableSource": { # The Cloud Bigtable source for importing data. # Cloud Bigtable input source. "bigtableOptions": { # The Bigtable Options object that contains information to support the import. # Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. "families": { # 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. - "a_key": { + "a_key": { # The column family of the Bigtable. "columns": [ # 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. - { - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. - "qualifier": "A String", # Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. - "type": "A String", # Optional. 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. + { # The column of the Bigtable. + "encoding": "A String", # 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. + "fieldName": "A String", # 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. + "qualifier": "A String", # Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. + "type": "A String", # 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`. }, ], - "encoding": "A String", # Optional. 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. - "fieldName": "A String", # The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. - "type": "A String", # Optional. 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. + "encoding": "A String", # 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. + "fieldName": "A String", # 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": "A String", # 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`. }, }, - "keyFieldName": "A String", # The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* + "keyFieldName": "A String", # The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. }, - "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be exported. - "projectId": "A String", # The project ID (can be project # or 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. - "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be exported. + "instanceId": "A String", # Required. The instance ID of the Cloud Bigtable that needs to be imported. + "projectId": "A String", # 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. + "tableId": "A String", # Required. The table ID of the Cloud Bigtable that needs to be imported. }, "cloudSqlSource": { # Cloud SQL source import data from. # Cloud SQL input source. "databaseId": "A String", # Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. - "offload": True or False, # Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "offload": True or False, # Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). + "projectId": "A String", # 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. "tableId": "A String", # Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. @@ -281,18 +281,18 @@

Method Details

"gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. }, "firestoreSource": { # Firestore source import data from. # Firestore input source. - "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1500 characters. + "collectionId": "A String", # Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. "databaseId": "A String", # Required. The Firestore database to copy the data from with a length limit of 256 characters. - "gcsStagingDir": "A String", # Optional. 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. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. - "projectId": "A String", # Optional. The project ID (can be project # or 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. + "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + "projectId": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], }, - "idField": "A String", # 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 + "idField": "A String", # 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. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. @@ -319,11 +319,12 @@

Method Details

"reconciliationMode": "A String", # The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. "spannerSource": { # The Spanner source for importing data # Spanner input source. "databaseId": "A String", # Required. The database ID of the source Spanner table. - "enableDataBoost": True or False, # Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas + "enableDataBoost": True or False, # 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). "instanceId": "A String", # Required. The instance ID of the source Spanner table. "projectId": "A String", # 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. "tableId": "A String", # Required. The table name of the Spanner database that needs to be imported. }, + "updateMask": "A String", # Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html index 5a132e56bde..ebb04f3479d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.conversations.html @@ -118,6 +118,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 053dddaff4f..762abcf47bf 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -104,6 +104,11 @@

Instance Methods

Returns the servingConfigs Resource.

+

+ sessions() +

+

Returns the sessions Resource.

+

siteSearchEngine()

diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index ceed7cca943..878f3d5adca 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -74,6 +74,9 @@

Discovery Engine API . projects . locations . dataStores . servingConfigs

Instance Methods

+

+ answer(servingConfig, body=None, x__xgafv=None)

+

Answer query method.

close()

Close httplib2 connections.

@@ -99,6 +102,235 @@

Instance Methods

search_next()

Retrieves the next page of results.

Method Details

+
+ answer(servingConfig, body=None, x__xgafv=None) +
Answer query method.
+
+Args:
+  servingConfig: string, 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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.AnswerQuery method.
+  "answerGenerationSpec": { # Answer generation specification. # Answer generation specification.
+    "answerLanguageCode": "A String", # 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.
+    "ignoreAdversarialQuery": True or False, # 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.
+    "ignoreNonAnswerSeekingQuery": True or False, # 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.
+    "includeCitations": True or False, # Specifies whether to include citation metadata in the answer. The default value is `false`.
+    "modelSpec": { # Answer Generation Model specification. # Answer generation model specification.
+      "modelVersion": "A String", # Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.
+    },
+    "promptSpec": { # Answer generation prompt specification. # Answer generation prompt specification.
+      "preamble": "A String", # Customized preamble.
+    },
+  },
+  "asynchronousMode": True or False, # 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": { # Defines a user inputed query. # Required. Current user query.
+    "queryId": "A String", # Unique Id for the query.
+    "text": "A String", # Plain text.
+  },
+  "queryUnderstandingSpec": { # Query understanding specification. # Query understanding specification.
+    "queryClassificationSpec": { # Query classification specification. # Query classification specification.
+      "types": [ # Enabled query classification types.
+        "A String",
+      ],
+    },
+    "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification.
+      "disable": True or False, # Disable query rephraser.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.
+    },
+  },
+  "relatedQuestionsSpec": { # Related questions specification. # Related questions specification.
+    "enable": True or False, # Enable related questions feature if true.
+  },
+  "safetySpec": { # Safety specification. # Model specification.
+    "enable": True or False, # Enable the safety filtering on the answer response. It is false by default.
+  },
+  "searchSpec": { # Search specification. # Search specification.
+    "searchParams": { # Search parameters. # Search parameters.
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
+        "conditionBoostSpecs": [ # 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.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # 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.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # 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).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # 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).
+                  "attributeValue": "A String", # 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]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # 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": "A String", # 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)
+      "maxReturnResults": 42, # Number of search results to return. The default value is 10.
+      "orderBy": "A String", # 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.
+    },
+    "searchResultList": { # Search result list. # Search result list.
+      "searchResults": [ # Search results.
+        { # Search result.
+          "chunkInfo": { # Chunk information. # Chunk information.
+            "chunk": "A String", # Chunk resource name.
+            "content": "A String", # Chunk textual content.
+          },
+          "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+            "document": "A String", # Document resource name.
+            "documentContexts": [ # List of document contexts.
+              { # Document context.
+                "content": "A String", # Document content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveAnswers": [ # List of extractive answers.
+              { # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
+                "content": "A String", # Extractive answer content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "extractiveSegments": [ # List of extractive segments.
+              { # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                "content": "A String", # Extractive segment content.
+                "pageIdentifier": "A String", # Page identifier.
+              },
+            ],
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+        },
+      ],
+    },
+  },
+  "session": "A String", # 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.
+  "userPseudoId": "A 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`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.AnswerQuery method.
+  "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API.
+    "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+      "A String",
+    ],
+    "answerText": "A String", # The textual answer.
+    "citations": [ # Citations.
+      { # Citation info for a segment.
+        "endIndex": "A String", # End of the attributed segment, exclusive.
+        "sources": [ # Citation sources for the attributed segment.
+          { # Citation source.
+            "referenceId": "A String", # ID of the citation source.
+          },
+        ],
+        "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+      },
+    ],
+    "completeTime": "A String", # Output only. Answer completed timestamp.
+    "createTime": "A String", # Output only. Answer creation timestamp.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+    "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+      "queryClassificationInfo": [ # Query classification information.
+        { # Query classification information.
+          "positive": True or False, # Classification output.
+          "type": "A String", # Query classification type.
+        },
+      ],
+    },
+    "references": [ # References.
+      { # Reference.
+        "chunkInfo": { # Chunk information. # Chunk information.
+          "chunk": "A String", # Chunk resource name.
+          "content": "A String", # Chunk textual content.
+          "documentMetadata": { # Document metadata. # Document metadata.
+            "document": "A String", # Document resource name.
+            "pageIdentifier": "A String", # Page identifier.
+            "title": "A String", # Title.
+            "uri": "A String", # URI for the document.
+          },
+          "relevanceScore": 3.14, # Relevance score.
+        },
+        "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+          "chunkContents": [ # List of cited chunk contents derived from document content.
+            { # Chunk content.
+              "content": "A String", # Chunk textual content.
+              "pageIdentifier": "A String", # Page identifier.
+            },
+          ],
+          "document": "A String", # Document resource name.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+      },
+    ],
+    "relatedQuestions": [ # Suggested related questions.
+      "A String",
+    ],
+    "state": "A String", # The state of the answer generation.
+    "steps": [ # Answer generation steps.
+      { # Step information.
+        "actions": [ # Actions.
+          { # Action.
+            "observation": { # Observation. # Observation.
+              "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+                {
+                  "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                    { # Chunk information.
+                      "chunk": "A String", # Chunk resource name.
+                      "content": "A String", # Chunk textual content.
+                      "relevanceScore": 3.14, # Relevance score.
+                    },
+                  ],
+                  "document": "A String", # Document resource name.
+                  "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                    { # Snippet information.
+                      "snippet": "A String", # Snippet content.
+                      "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                    },
+                  ],
+                  "title": "A String", # Title.
+                  "uri": "A String", # URI for the document.
+                },
+              ],
+            },
+            "searchAction": { # Search action. # Search action.
+              "query": "A String", # The query to search.
+            },
+          },
+        ],
+        "description": "A String", # The description of the step.
+        "state": "A String", # The state of the step.
+        "thought": "A String", # The thought of the step.
+      },
+    ],
+  },
+  "session": { # External session proto definition. # Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request.
+    "endTime": "A String", # Output only. The time the session finished.
+    "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+    "startTime": "A String", # Output only. The time the session started.
+    "state": "A String", # The state of the session.
+    "turns": [ # Turns.
+      { # Represents a turn, including a query from the user and a answer from service.
+        "answer": "A String", # The resource name of the answer to the user query.
+        "query": { # Defines a user inputed query. # The user query.
+          "queryId": "A String", # Unique Id for the query.
+          "text": "A String", # Plain text.
+        },
+      },
+    ],
+    "userPseudoId": "A String", # A unique identifier for tracking users.
+  },
+}
+
+
close()
Close httplib2 connections.
@@ -622,6 +854,17 @@

Method Details

"conditionBoostSpecs": [ # 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. { # Boost applies to documents which match a condition. "boost": 3.14, # 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. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # 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). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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). + "attributeValue": "A String", # 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]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # 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"))` }, ], @@ -708,7 +951,7 @@

Method Details

}, "offset": 42, # 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. "orderBy": "A String", # 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. - "pageSize": 42, # Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned. + "pageSize": 42, # 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. "pageToken": "A String", # 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. "params": { # 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. 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. Example: search_type: 1 "a_key": "", diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html new file mode 100644 index 00000000000..3c40b3d6390 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -0,0 +1,199 @@ + + + +

Discovery Engine API . projects . locations . dataStores . sessions . answers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a Answer.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a Answer.
+
+Args:
+  name: string, 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an answer.
+  "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
+    "A String",
+  ],
+  "answerText": "A String", # The textual answer.
+  "citations": [ # Citations.
+    { # Citation info for a segment.
+      "endIndex": "A String", # End of the attributed segment, exclusive.
+      "sources": [ # Citation sources for the attributed segment.
+        { # Citation source.
+          "referenceId": "A String", # ID of the citation source.
+        },
+      ],
+      "startIndex": "A String", # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
+    },
+  ],
+  "completeTime": "A String", # Output only. Answer completed timestamp.
+  "createTime": "A String", # Output only. Answer creation timestamp.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+  "queryUnderstandingInfo": { # Query understanding information. # Query understanding information.
+    "queryClassificationInfo": [ # Query classification information.
+      { # Query classification information.
+        "positive": True or False, # Classification output.
+        "type": "A String", # Query classification type.
+      },
+    ],
+  },
+  "references": [ # References.
+    { # Reference.
+      "chunkInfo": { # Chunk information. # Chunk information.
+        "chunk": "A String", # Chunk resource name.
+        "content": "A String", # Chunk textual content.
+        "documentMetadata": { # Document metadata. # Document metadata.
+          "document": "A String", # Document resource name.
+          "pageIdentifier": "A String", # Page identifier.
+          "title": "A String", # Title.
+          "uri": "A String", # URI for the document.
+        },
+        "relevanceScore": 3.14, # Relevance score.
+      },
+      "unstructuredDocumentInfo": { # Unstructured document information. # Unstructured document information.
+        "chunkContents": [ # List of cited chunk contents derived from document content.
+          { # Chunk content.
+            "content": "A String", # Chunk textual content.
+            "pageIdentifier": "A String", # Page identifier.
+          },
+        ],
+        "document": "A String", # Document resource name.
+        "title": "A String", # Title.
+        "uri": "A String", # URI for the document.
+      },
+    },
+  ],
+  "relatedQuestions": [ # Suggested related questions.
+    "A String",
+  ],
+  "state": "A String", # The state of the answer generation.
+  "steps": [ # Answer generation steps.
+    { # Step information.
+      "actions": [ # Actions.
+        { # Action.
+          "observation": { # Observation. # Observation.
+            "searchResults": [ # Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.
+              {
+                "chunkInfo": [ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
+                  { # Chunk information.
+                    "chunk": "A String", # Chunk resource name.
+                    "content": "A String", # Chunk textual content.
+                    "relevanceScore": 3.14, # Relevance score.
+                  },
+                ],
+                "document": "A String", # Document resource name.
+                "snippetInfo": [ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
+                  { # Snippet information.
+                    "snippet": "A String", # Snippet content.
+                    "snippetStatus": "A String", # Status of the snippet defined by the search team.
+                  },
+                ],
+                "title": "A String", # Title.
+                "uri": "A String", # URI for the document.
+              },
+            ],
+          },
+          "searchAction": { # Search action. # Search action.
+            "query": "A String", # The query to search.
+          },
+        },
+      ],
+      "description": "A String", # The description of the step.
+      "state": "A String", # The state of the step.
+      "thought": "A String", # The thought of the step.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html new file mode 100644 index 00000000000..7350484c210 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html @@ -0,0 +1,319 @@ + + + +

Discovery Engine API . projects . locations . dataStores . sessions

+

Instance Methods

+

+ answers() +

+

Returns the answers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.

+

+ delete(name, x__xgafv=None)

+

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.

+

+ get(name, x__xgafv=None)

+

Gets a Session.

+

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

+

Lists all Sessions by their parent DataStore.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.
+
+Args:
+  parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: 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}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Session.
+
+Args:
+  name: 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)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all Sessions by their parent DataStore.
+
+Args:
+  parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
+  filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
+  orderBy: 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"
+  pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
+  pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListSessions method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "sessions": [ # All the Sessions for a given data store.
+    { # External session proto definition.
+      "endTime": "A String", # Output only. The time the session finished.
+      "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+      "startTime": "A String", # Output only. The time the session started.
+      "state": "A String", # The state of the session.
+      "turns": [ # Turns.
+        { # Represents a turn, including a query from the user and a answer from service.
+          "answer": "A String", # The resource name of the answer to the user query.
+          "query": { # Defines a user inputed query. # The user query.
+            "queryId": "A String", # Unique Id for the query.
+            "text": "A String", # Plain text.
+          },
+        },
+      ],
+      "userPseudoId": "A String", # A unique identifier for tracking users.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.
+
+Args:
+  name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+  updateMask: 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # External session proto definition.
+  "endTime": "A String", # Output only. The time the session finished.
+  "name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+  "startTime": "A String", # Output only. The time the session started.
+  "state": "A String", # The state of the session.
+  "turns": [ # Turns.
+    { # Represents a turn, including a query from the user and a answer from service.
+      "answer": "A String", # The resource name of the answer to the user query.
+      "query": { # Defines a user inputed query. # The user query.
+        "queryId": "A String", # Unique Id for the query.
+        "text": "A String", # Plain text.
+      },
+    },
+  ],
+  "userPseudoId": "A String", # A unique identifier for tracking users.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.suggestionDenyListEntries.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.suggestionDenyListEntries.html index 17649107074..a81e2a597d5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.suggestionDenyListEntries.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.suggestionDenyListEntries.html @@ -100,7 +100,7 @@

Method Details

{ # Request message for CompletionService.ImportSuggestionDenyListEntries method. "gcsSource": { # Cloud Storage location for input content. # 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. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html index 41d91194a93..f227c70e15a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -131,7 +131,7 @@

Method Details

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

Method Details

"gcsPrefix": "A String", # 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. }, "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content. - "dataSchema": "A String", # 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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. + "dataSchema": "A String", # 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 even imports: * `user_event` (default): One JSON UserEvent per line. "inputUris": [ # Required. Cloud Storage URIs to input files. 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`). "A String", ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html new file mode 100644 index 00000000000..bb83c31367a --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html @@ -0,0 +1,145 @@ + + + +

Discovery Engine API . projects . locations . groundingConfigs

+

Instance Methods

+

+ check(groundingConfig, body=None, x__xgafv=None)

+

Performs a grounding check.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ check(groundingConfig, body=None, x__xgafv=None) +
Performs a grounding check.
+
+Args:
+  groundingConfig: string, Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GroundedGenerationService.CheckGrounding method.
+  "answerCandidate": "A String", # Answer candidate to check.
+  "facts": [ # List of facts for the grounding check. We support up to 200 facts.
+    { # Grounding Fact.
+      "attributes": { # 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.
+        "a_key": "A String",
+      },
+      "factText": "A String", # Text content of the fact. Can be at most 10K characters long.
+    },
+  ],
+  "groundingSpec": { # Specification for the grounding check. # Configuration of the grounding check.
+    "citationThreshold": 3.14, # 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.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the GroundedGenerationService.CheckGrounding method.
+  "citedChunks": [ # List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.
+    { # Fact Chunk.
+      "chunkText": "A String", # Text content of the fact chunk. Can be at most 10K characters long.
+      "source": "A String", # 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.
+      "sourceMetadata": { # More fine-grained information for the source reference.
+        "a_key": "A String",
+      },
+    },
+  ],
+  "claims": [ # Claim texts and citation info across all claims in the answer candidate.
+    { # Text and citation info for a claim in the answer candidate.
+      "citationIndices": [ # 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.
+        42,
+      ],
+      "claimText": "A String", # Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
+      "endPos": 42, # Position indicating the end of the claim in the answer candidate, exclusive.
+      "startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes/unicode.
+    },
+  ],
+  "supportScore": 3.14, # 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.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.html index 692facc6ea9..3332034b09e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the dataStores Resource.

+

+ groundingConfigs() +

+

Returns the groundingConfigs Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.rankingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.rankingConfigs.html index fa2a2b018d1..bc89ce0f43d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.rankingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.rankingConfigs.html @@ -99,7 +99,7 @@

Method Details

"ignoreRecordDetailsInResponse": True or False, # If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. "model": "A String", # 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. "query": "A String", # The query to use. - "records": [ # Required. A list of records to rank. + "records": [ # Required. A list of records to rank. At most 100 records to rank. { # Record message for RankService.Rank method. "content": "A String", # 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. "id": "A String", # The unique ID to represent the record. diff --git a/docs/dyn/dlp_v2.organizations.locations.connections.html b/docs/dyn/dlp_v2.organizations.locations.connections.html new file mode 100644 index 00000000000..cb286baa9dc --- /dev/null +++ b/docs/dyn/dlp_v2.organizations.locations.connections.html @@ -0,0 +1,161 @@ + + + +

Sensitive Data Protection (DLP) . organizations . locations . connections

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Searches for Connections in a parent.

+

+ search_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Searches for Connections in a parent.
+
+Args:
+  parent: string, Required. Parent name, typically an organization, without location. For example: "organizations/12345678". (required)
+  filter: string, Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR
+  pageSize: integer, Optional. Number of results per page, max 1000.
+  pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SearchConnections.
+  "connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+      "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+        "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+        },
+        "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+        "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+        "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+        "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+          "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+          "username": "A String", # Required. The username.
+        },
+      },
+      "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+        { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+          "details": { # 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). # Detailed error codes and messages.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+          "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+            "A String",
+          ],
+        },
+      ],
+      "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+      "state": "A String", # Required. The connection's state in its lifecycle.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results. An empty value means there are no more results.
+}
+
+ +
+ search_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 6035ca5de1d..bf8e306927c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -219,6 +219,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -340,6 +381,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -485,6 +567,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -617,6 +740,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -757,6 +921,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -879,6 +1084,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. diff --git a/docs/dyn/dlp_v2.organizations.locations.html b/docs/dyn/dlp_v2.organizations.locations.html index ffb466da187..93aa02e65b9 100644 --- a/docs/dyn/dlp_v2.organizations.locations.html +++ b/docs/dyn/dlp_v2.organizations.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the columnDataProfiles Resource.

+

+ connections() +

+

Returns the connections Resource.

+

deidentifyTemplates()

diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html index 15e5aa7386d..cb26f41fcba 100644 --- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Request message for CreateJobTrigger. - "jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create. + "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -462,7 +462,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -835,7 +835,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -1202,7 +1202,7 @@

Method Details

{ # Response message for ListJobTriggers. "jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest. - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -1570,7 +1570,7 @@

Method Details

The object takes the form of: { # Request message for UpdateJobTrigger. - "jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. + "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -1920,7 +1920,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 5d6aba4c0ae..642037ec127 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

get(name, x__xgafv=None)

Gets a table data profile.

@@ -92,6 +95,24 @@

Method Details

Close httplib2 connections.
+
+ delete(name, x__xgafv=None) +
Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.
+
+Args:
+  name: string, Required. Resource name of the table data profile. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
Gets a table data profile.
@@ -252,6 +273,47 @@ 

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -674,6 +736,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 311ed701f55..79e1b04e508 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -3827,7 +3827,7 @@

Method Details

The object takes the form of: { # Request message for CreateJobTrigger. - "jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create. + "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4178,7 +4178,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4551,7 +4551,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4918,7 +4918,7 @@

Method Details

{ # Response message for ListJobTriggers. "jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest. - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5286,7 +5286,7 @@

Method Details

The object takes the form of: { # Request message for UpdateJobTrigger. - "jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. + "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5636,7 +5636,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) diff --git a/docs/dyn/dlp_v2.projects.locations.connections.html b/docs/dyn/dlp_v2.projects.locations.connections.html new file mode 100644 index 00000000000..8de8561a60b --- /dev/null +++ b/docs/dyn/dlp_v2.projects.locations.connections.html @@ -0,0 +1,482 @@ + + + +

Sensitive Data Protection (DLP) . projects . locations . connections

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Create a Connection to an external data source.

+

+ delete(name, x__xgafv=None)

+

Delete a Connection.

+

+ get(name, x__xgafv=None)

+

Get a Connection by name.

+

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

+

Lists Connections in a parent.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Update a Connection.

+

+ search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Searches for Connections in a parent.

+

+ search_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Create a Connection to an external data source.
+
+Args:
+  parent: string, Required. Parent resource name in the format: "projects/{project}/locations/{location}". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CreateConnection.
+  "connection": { # A data connection to allow DLP to profile data in locations that require additional configuration. # Required. The connection resource.
+    "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+      "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+      },
+      "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+      "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+      "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+      "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+        "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+        "username": "A String", # Required. The username.
+      },
+    },
+    "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+      { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+        "details": { # 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). # Detailed error codes and messages.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+          "A String",
+        ],
+      },
+    ],
+    "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+    "state": "A String", # Required. The connection's state in its lifecycle.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+  "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+    "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+    },
+    "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+    "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+    "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+    "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+      "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+      "username": "A String", # Required. The username.
+    },
+  },
+  "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+    { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+      "details": { # 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). # Detailed error codes and messages.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+        "A String",
+      ],
+    },
+  ],
+  "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+  "state": "A String", # Required. The connection's state in its lifecycle.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete a Connection.
+
+Args:
+  name: string, Required. Resource name of the Connection to be deleted, in the format: "projects/{project}/locations/{location}/connections/{connection}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Get a Connection by name.
+
+Args:
+  name: string, Required. Resource name in the format: "projects/{project}/locations/{location}/connections/{connection}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+  "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+    "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+    },
+    "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+    "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+    "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+    "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+      "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+      "username": "A String", # Required. The username.
+    },
+  },
+  "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+    { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+      "details": { # 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). # Detailed error codes and messages.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+        "A String",
+      ],
+    },
+  ],
+  "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+  "state": "A String", # Required. The connection's state in its lifecycle.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Connections in a parent.
+
+Args:
+  parent: string, Required. Parent name, for example: "projects/project-id/locations/global". (required)
+  filter: string, Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR
+  pageSize: integer, Optional. Number of results per page, max 1000.
+  pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListConnections.
+  "connections": [ # List of connections.
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+      "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+        "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+        },
+        "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+        "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+        "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+        "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+          "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+          "username": "A String", # Required. The username.
+        },
+      },
+      "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+        { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+          "details": { # 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). # Detailed error codes and messages.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+          "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+            "A String",
+          ],
+        },
+      ],
+      "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+      "state": "A String", # Required. The connection's state in its lifecycle.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results. An empty value means there are no more results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, x__xgafv=None) +
Update a Connection.
+
+Args:
+  name: string, Required. Resource name in the format: "projects/{project}/locations/{location}/connections/{connection}". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UpdateConnection.
+  "connection": { # A data connection to allow DLP to profile data in locations that require additional configuration. # Required. The connection with new values for the relevant fields.
+    "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+      "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+      },
+      "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+      "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+      "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+      "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+        "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+        "username": "A String", # Required. The username.
+      },
+    },
+    "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+      { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+        "details": { # 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). # Detailed error codes and messages.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+          "A String",
+        ],
+      },
+    ],
+    "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+    "state": "A String", # Required. The connection's state in its lifecycle.
+  },
+  "updateMask": "A String", # Optional. Mask to control which fields get updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+  "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+    "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+    },
+    "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+    "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+    "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+    "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+      "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+      "username": "A String", # Required. The username.
+    },
+  },
+  "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+    { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+      "details": { # 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). # Detailed error codes and messages.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+        "A String",
+      ],
+    },
+  ],
+  "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+  "state": "A String", # Required. The connection's state in its lifecycle.
+}
+
+ +
+ search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Searches for Connections in a parent.
+
+Args:
+  parent: string, Required. Parent name, typically an organization, without location. For example: "organizations/12345678". (required)
+  filter: string, Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR
+  pageSize: integer, Optional. Number of results per page, max 1000.
+  pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SearchConnections.
+  "connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+      "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+        "cloudSqlIam": { # Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+        },
+        "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name "project-id:us-central1:sql-instance" must be created under the parent "projects/project-id/locations/us-central1"
+        "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+        "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+        "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+          "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form "projects/project-id/secrets/secret-name/versions/version".
+          "username": "A String", # Required. The username.
+        },
+      },
+      "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+        { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+          "details": { # 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). # Detailed error codes and messages.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+          "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+            "A String",
+          ],
+        },
+      ],
+      "name": "A String", # Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.
+      "state": "A String", # Required. The connection's state in its lifecycle.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results. An empty value means there are no more results.
+}
+
+ +
+ search_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 9ba80c6139b..4106364d518 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -219,6 +219,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -340,6 +381,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -485,6 +567,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -617,6 +740,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -757,6 +921,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -879,6 +1084,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. diff --git a/docs/dyn/dlp_v2.projects.locations.html b/docs/dyn/dlp_v2.projects.locations.html index d426de3cd23..a5fcc8f9609 100644 --- a/docs/dyn/dlp_v2.projects.locations.html +++ b/docs/dyn/dlp_v2.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the columnDataProfiles Resource.

+

+ connections() +

+

Returns the connections Resource.

+

content()

diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index b4ff13302be..bdf2f8015c8 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -3830,7 +3830,7 @@

Method Details

The object takes the form of: { # Request message for CreateJobTrigger. - "jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create. + "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # Required. The JobTrigger to create. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4181,7 +4181,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -4554,7 +4554,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5009,7 +5009,7 @@

Method Details

{ # Response message for ListJobTriggers. "jobTriggers": [ # List of triggeredJobs, up to page_size in ListJobTriggersRequest. - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5377,7 +5377,7 @@

Method Details

The object takes the form of: { # Request message for UpdateJobTrigger. - "jobTrigger": { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. + "jobTrigger": { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. # New JobTrigger value. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) @@ -5727,7 +5727,7 @@

Method Details

Returns: An object of the form: - { # Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. + { # Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more. "createTime": "A String", # Output only. The creation timestamp of a triggeredJob. "description": "A String", # User provided description (max 256 chars) "displayName": "A String", # Display name (max 100 chars) diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index c17704fdb96..79cecadda30 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

get(name, x__xgafv=None)

Gets a table data profile.

@@ -92,6 +95,24 @@

Method Details

Close httplib2 connections.
+
+ delete(name, x__xgafv=None) +
Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.
+
+Args:
+  name: string, Required. Resource name of the table data profile. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
get(name, x__xgafv=None)
Gets a table data profile.
@@ -252,6 +273,47 @@ 

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. @@ -674,6 +736,47 @@

Method Details

}, }, }, + "cloudSqlTarget": { # Target used to match against for discovery with Cloud SQL tables. # Cloud SQL target for Discovery. The first target to match a table will be the one applied. + "conditions": { # Requirements that must be true before a table is profiled for the first time. # In addition to matching the filter, these conditions must be true before a profile is generated. + "databaseEngines": [ # Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified. + "A String", + ], + "types": [ # Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES]. + "A String", + ], + }, + "disabled": { # Do not profile the tables. # Disable profiling for database resources that match this filter. + }, + "filter": { # Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name. # Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table. + "collection": { # Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures. # A specific set of database resources for this filter to apply to. + "includeRegexes": { # A collection of regular expressions to determine what database resources to match against. # A collection of regular expressions to match a database resource against. + "patterns": [ # A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + { # A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + "databaseRegex": "A String", # Regex to test the database name against. If empty, all databases match. + "databaseResourceNameRegex": "A String", # Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match. + "instanceRegex": "A String", # Regex to test the instance name against. If empty, all instances match. + "projectIdRegex": "A String", # For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project. + }, + ], + }, + }, + "databaseResourceReference": { # Identifies a single database resource, like a table within a database. # The database resource to scan. Targets including this can only include one target (the target with this database resource reference). + "instance": "A String", # Required. The instance where this resource is located. For example: Cloud SQL's instance id. + "projectId": "A String", # Required. If within a project-level config, then this must match the config's project id. + }, + "others": { # Match database resources not covered by any other filter. # 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. + }, + }, + "generationCadence": { # How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + "refreshFrequency": "A String", # Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. Defaults to never. + "schemaModifiedCadence": { # How frequency to modify the profile when the table's schema is modified. # When to reprofile if the schema has changed. + "frequency": "A String", # Frequency to regenerate data profiles when the schema is modified. Defaults to monthly. + "types": [ # The types of schema modifications to consider. Defaults to NEW_COLUMNS. + "A String", + ], + }, + }, + }, }, ], "updateTime": "A String", # Output only. The last update timestamp of a DiscoveryConfig. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index ec696f1a2d7..3e8d933e616 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -464,8 +464,8 @@

Method Details

"operation": "A String", # The resource name of the Long Running Operation for the evaluation. }, "modelType": "A String", # Output only. The model type of this processor version. - "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - "state": "A String", # The state of the processor version. + "name": "A String", # Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + "state": "A String", # Output only. The state of the processor version. }
@@ -561,8 +561,8 @@

Method Details

"operation": "A String", # The resource name of the Long Running Operation for the evaluation. }, "modelType": "A String", # Output only. The model type of this processor version. - "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - "state": "A String", # The state of the processor version. + "name": "A String", # Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + "state": "A String", # Output only. The state of the processor version. }, ], }
@@ -2529,8 +2529,8 @@

Method Details

"operation": "A String", # The resource name of the Long Running Operation for the evaluation. }, "modelType": "A String", # Output only. The model type of this processor version. - "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - "state": "A String", # The state of the processor version. + "name": "A String", # Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + "state": "A String", # Output only. The state of the processor version. }, } diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 2d6bdfe4ef2..87afc3839b6 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -500,8 +500,8 @@

Method Details

"operation": "A String", # The resource name of the Long Running Operation for the evaluation. }, "modelType": "A String", # Output only. The model type of this processor version. - "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - "state": "A String", # The state of the processor version. + "name": "A String", # Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + "state": "A String", # Output only. The state of the processor version. }
@@ -655,8 +655,8 @@

Method Details

"operation": "A String", # The resource name of the Long Running Operation for the evaluation. }, "modelType": "A String", # Output only. The model type of this processor version. - "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - "state": "A String", # The state of the processor version. + "name": "A String", # Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + "state": "A String", # Output only. The state of the processor version. }, ], } @@ -3506,8 +3506,8 @@

Method Details

"operation": "A String", # The resource name of the Long Running Operation for the evaluation. }, "modelType": "A String", # Output only. The model type of this processor version. - "name": "A String", # The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` - "state": "A String", # The state of the processor version. + "name": "A String", # Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` + "state": "A String", # Output only. The state of the processor version. }, } diff --git a/docs/dyn/firebaseml_v2beta.html b/docs/dyn/firebaseml_v2beta.html new file mode 100644 index 00000000000..c13b5886961 --- /dev/null +++ b/docs/dyn/firebaseml_v2beta.html @@ -0,0 +1,111 @@ + + + +

Firebase ML API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebaseml_v2beta.projects.html b/docs/dyn/firebaseml_v2beta.projects.html new file mode 100644 index 00000000000..baacfff530f --- /dev/null +++ b/docs/dyn/firebaseml_v2beta.projects.html @@ -0,0 +1,91 @@ + + + +

Firebase ML API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.html b/docs/dyn/firebaseml_v2beta.projects.locations.html new file mode 100644 index 00000000000..30c35105be9 --- /dev/null +++ b/docs/dyn/firebaseml_v2beta.projects.locations.html @@ -0,0 +1,91 @@ + + + +

Firebase ML API . projects . locations

+

Instance Methods

+

+ publishers() +

+

Returns the publishers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.html new file mode 100644 index 00000000000..97ad29ef9e1 --- /dev/null +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.html @@ -0,0 +1,91 @@ + + + +

Firebase ML API . projects . locations . publishers

+

Instance Methods

+

+ models() +

+

Returns the models Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html new file mode 100644 index 00000000000..b924d17dca1 --- /dev/null +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -0,0 +1,737 @@ + + + +

Firebase ML API . projects . locations . publishers . models

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ countTokens(endpoint, body=None, x__xgafv=None)

+

Perform a token counting.

+

+ generateContent(model, body=None, x__xgafv=None)

+

Generate content with multimodal inputs.

+

+ streamGenerateContent(model, body=None, x__xgafv=None)

+

Generate content with multimodal inputs with streaming support.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ countTokens(endpoint, body=None, x__xgafv=None) +
Perform a token counting.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.CountTokens.
+  "contents": [ # Required. Input content.
+    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "fileData": { # URI based data. # Optional. URI based data.
+            "fileUri": "A String", # Required. URI.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+          },
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "response": { # Required. The function response in JSON object format.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+            "data": "A String", # Required. Raw bytes.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "text": "A String", # Optional. Text part (can be code).
+          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "endOffset": "A String", # Optional. The end offset of the video.
+            "startOffset": "A String", # Optional. The start offset of the video.
+          },
+        },
+      ],
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    },
+  ],
+  "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.
+    "",
+  ],
+  "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for PredictionService.CountTokens.
+  "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request.
+  "totalTokens": 42, # The total number of tokens counted across all instances from the request.
+}
+
+ +
+ generateContent(model, body=None, x__xgafv=None) +
Generate content with multimodal inputs.
+
+Args:
+  model: string, Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [PredictionService.GenerateContent].
+  "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
+    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "fileData": { # URI based data. # Optional. URI based data.
+            "fileUri": "A String", # Required. URI.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+          },
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "response": { # Required. The function response in JSON object format.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+            "data": "A String", # Required. Raw bytes.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "text": "A String", # Optional. Text part (can be code).
+          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "endOffset": "A String", # Optional. The end offset of the video.
+            "startOffset": "A String", # Optional. The start offset of the video.
+          },
+        },
+      ],
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    },
+  ],
+  "generationConfig": { # Generation config. # Optional. Generation config.
+    "candidateCount": 42, # Optional. Number of candidates to generate.
+    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+    "presencePenalty": 3.14, # Optional. Positive penalties.
+    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+    "stopSequences": [ # Optional. Stop sequences.
+      "A String",
+    ],
+    "temperature": 3.14, # Optional. Controls the randomness of predictions.
+    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+  },
+  "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
+    { # Safety settings.
+      "category": "A String", # Required. Harm category.
+      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
+      "threshold": "A String", # Required. The harm block threshold.
+    },
+  ],
+  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # 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.
+    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "fileData": { # URI based data. # Optional. URI based data.
+          "fileUri": "A String", # Required. URI.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+          "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+            "a_key": "", # Properties of the object.
+          },
+          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+        },
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "response": { # Required. The function response in JSON object format.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+          "data": "A String", # Required. Raw bytes.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "text": "A String", # Optional. Text part (can be code).
+        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "endOffset": "A String", # Optional. The end offset of the video.
+          "startOffset": "A String", # Optional. The start offset of the video.
+        },
+      },
+    ],
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+  },
+  "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
+    "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
+      "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
+        "A String",
+      ],
+      "mode": "A String", # Optional. Function calling mode.
+    },
+  },
+  "tools": [ # 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.
+    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.
+        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
+          "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+            "default": "", # Optional. Default value of the data.
+            "description": "A String", # Optional. The description of the data.
+            "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+              "A String",
+            ],
+            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+            "items": # Object with schema name: Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+            "nullable": True or False, # Optional. Indicates if the value may be null.
+            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+              "a_key": # Object with schema name: Schema
+            },
+            "required": [ # Optional. Required properties of Type.OBJECT.
+              "A String",
+            ],
+            "title": "A String", # Optional. The title of the Schema.
+            "type": "A String", # Optional. The type of the data.
+          },
+          "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+            "default": "", # Optional. Default value of the data.
+            "description": "A String", # Optional. The description of the data.
+            "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+              "A String",
+            ],
+            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+            "items": # Object with schema name: Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+            "nullable": True or False, # Optional. Indicates if the value may be null.
+            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+              "a_key": # Object with schema name: Schema
+            },
+            "required": [ # Optional. Required properties of Type.OBJECT.
+              "A String",
+            ],
+            "title": "A String", # Optional. The title of the Schema.
+            "type": "A String", # Optional. The type of the data.
+          },
+        },
+      ],
+      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+        "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
+          "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+        },
+        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+          "ragCorpora": [ # Required. Vertex RAG Store corpus resource name: `projects/{project}/locations/{location}/ragCorpora/{ragCorpus}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.
+            "A String",
+          ],
+          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+        },
+      },
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for [PredictionService.GenerateContent].
+  "candidates": [ # Output only. Generated candidates.
+    { # A response candidate generated from the model.
+      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
+        "citations": [ # Output only. List of citations.
+          { # Source attributions for content.
+            "endIndex": 42, # Output only. End index into the content.
+            "license": "A String", # Output only. License of the attribution.
+            "publicationDate": { # 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 # Output only. Publication date of the attribution.
+              "day": 42, # 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.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "startIndex": 42, # Output only. Start index into the content.
+            "title": "A String", # Output only. Title of the attribution.
+            "uri": "A String", # Output only. Url reference of the attribution.
+          },
+        ],
+      },
+      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
+        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "fileData": { # URI based data. # Optional. URI based data.
+              "fileUri": "A String", # Required. URI.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+              "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                "a_key": "", # Properties of the object.
+              },
+              "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+            },
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+              "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "response": { # Required. The function response in JSON object format.
+                "a_key": "", # Properties of the object.
+              },
+            },
+            "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+              "data": "A String", # Required. Raw bytes.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "text": "A String", # Optional. Text part (can be code).
+            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "endOffset": "A String", # Optional. The end offset of the video.
+              "startOffset": "A String", # Optional. The start offset of the video.
+            },
+          },
+        ],
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+      },
+      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
+      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
+      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
+        "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+          "A String",
+        ],
+        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+          "A String",
+        ],
+      },
+      "index": 42, # Output only. Index of the candidate.
+      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
+        { # Safety rating corresponding to the generated content.
+          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
+          "category": "A String", # Output only. Harm category.
+          "probability": "A String", # Output only. Harm probability levels in the content.
+          "probabilityScore": 3.14, # Output only. Harm probability score.
+          "severity": "A String", # Output only. Harm severity levels in the content.
+          "severityScore": 3.14, # Output only. Harm severity score.
+        },
+      ],
+    },
+  ],
+  "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
+    "blockReason": "A String", # Output only. Blocked reason.
+    "blockReasonMessage": "A String", # Output only. A readable block reason message.
+    "safetyRatings": [ # Output only. Safety ratings.
+      { # Safety rating corresponding to the generated content.
+        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
+        "category": "A String", # Output only. Harm category.
+        "probability": "A String", # Output only. Harm probability levels in the content.
+        "probabilityScore": 3.14, # Output only. Harm probability score.
+        "severity": "A String", # Output only. Harm severity levels in the content.
+        "severityScore": 3.14, # Output only. Harm severity score.
+      },
+    ],
+  },
+  "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s).
+    "candidatesTokenCount": 42, # Number of tokens in the response(s).
+    "promptTokenCount": 42, # Number of tokens in the request.
+    "totalTokenCount": 42,
+  },
+}
+
+ +
+ streamGenerateContent(model, body=None, x__xgafv=None) +
Generate content with multimodal inputs with streaming support.
+
+Args:
+  model: string, Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for [PredictionService.GenerateContent].
+  "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
+    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
+      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "fileData": { # URI based data. # Optional. URI based data.
+            "fileUri": "A String", # Required. URI.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+              "a_key": "", # Properties of the object.
+            },
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+          },
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "response": { # Required. The function response in JSON object format.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+            "data": "A String", # Required. Raw bytes.
+            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+          },
+          "text": "A String", # Optional. Text part (can be code).
+          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "endOffset": "A String", # Optional. The end offset of the video.
+            "startOffset": "A String", # Optional. The start offset of the video.
+          },
+        },
+      ],
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    },
+  ],
+  "generationConfig": { # Generation config. # Optional. Generation config.
+    "candidateCount": 42, # Optional. Number of candidates to generate.
+    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
+    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
+    "presencePenalty": 3.14, # Optional. Positive penalties.
+    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+    "stopSequences": [ # Optional. Stop sequences.
+      "A String",
+    ],
+    "temperature": 3.14, # Optional. Controls the randomness of predictions.
+    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
+    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+  },
+  "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
+    { # Safety settings.
+      "category": "A String", # Required. Harm category.
+      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
+      "threshold": "A String", # Required. The harm block threshold.
+    },
+  ],
+  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # 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.
+    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "fileData": { # URI based data. # Optional. URI based data.
+          "fileUri": "A String", # Required. URI.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+          "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+            "a_key": "", # Properties of the object.
+          },
+          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+        },
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "response": { # Required. The function response in JSON object format.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+          "data": "A String", # Required. Raw bytes.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "text": "A String", # Optional. Text part (can be code).
+        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "endOffset": "A String", # Optional. The end offset of the video.
+          "startOffset": "A String", # Optional. The start offset of the video.
+        },
+      },
+    ],
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+  },
+  "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
+    "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
+      "allowedFunctionNames": [ # Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.
+        "A String",
+      ],
+      "mode": "A String", # Optional. Function calling mode.
+    },
+  },
+  "tools": [ # 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.
+    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.
+        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
+          "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+            "default": "", # Optional. Default value of the data.
+            "description": "A String", # Optional. The description of the data.
+            "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+              "A String",
+            ],
+            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+            "items": # Object with schema name: Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+            "nullable": True or False, # Optional. Indicates if the value may be null.
+            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+              "a_key": # Object with schema name: Schema
+            },
+            "required": [ # Optional. Required properties of Type.OBJECT.
+              "A String",
+            ],
+            "title": "A String", # Optional. The title of the Schema.
+            "type": "A String", # Optional. The type of the data.
+          },
+          "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+            "default": "", # Optional. Default value of the data.
+            "description": "A String", # Optional. The description of the data.
+            "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
+              "A String",
+            ],
+            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
+            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
+            "items": # Object with schema name: Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
+            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
+            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
+            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
+            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
+            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
+            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
+            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
+            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
+            "nullable": True or False, # Optional. Indicates if the value may be null.
+            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
+            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
+              "a_key": # Object with schema name: Schema
+            },
+            "required": [ # Optional. Required properties of Type.OBJECT.
+              "A String",
+            ],
+            "title": "A String", # Optional. The title of the Schema.
+            "type": "A String", # Optional. The type of the data.
+          },
+        },
+      ],
+      "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
+        "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
+          "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+        },
+        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+          "ragCorpora": [ # Required. Vertex RAG Store corpus resource name: `projects/{project}/locations/{location}/ragCorpora/{ragCorpus}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.
+            "A String",
+          ],
+          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+        },
+      },
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for [PredictionService.GenerateContent].
+  "candidates": [ # Output only. Generated candidates.
+    { # A response candidate generated from the model.
+      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
+        "citations": [ # Output only. List of citations.
+          { # Source attributions for content.
+            "endIndex": 42, # Output only. End index into the content.
+            "license": "A String", # Output only. License of the attribution.
+            "publicationDate": { # 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 # Output only. Publication date of the attribution.
+              "day": 42, # 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.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "startIndex": 42, # Output only. Start index into the content.
+            "title": "A String", # Output only. Title of the attribution.
+            "uri": "A String", # Output only. Url reference of the attribution.
+          },
+        ],
+      },
+      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
+        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
+          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "fileData": { # URI based data. # Optional. URI based data.
+              "fileUri": "A String", # Required. URI.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+              "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                "a_key": "", # Properties of the object.
+              },
+              "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name].
+            },
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+              "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "response": { # Required. The function response in JSON object format.
+                "a_key": "", # Properties of the object.
+              },
+            },
+            "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data.
+              "data": "A String", # Required. Raw bytes.
+              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+            },
+            "text": "A String", # Optional. Text part (can be code).
+            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "endOffset": "A String", # Optional. The end offset of the video.
+              "startOffset": "A String", # Optional. The start offset of the video.
+            },
+          },
+        ],
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+      },
+      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
+      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
+      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
+        "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+          "A String",
+        ],
+        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+          "A String",
+        ],
+      },
+      "index": 42, # Output only. Index of the candidate.
+      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
+        { # Safety rating corresponding to the generated content.
+          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
+          "category": "A String", # Output only. Harm category.
+          "probability": "A String", # Output only. Harm probability levels in the content.
+          "probabilityScore": 3.14, # Output only. Harm probability score.
+          "severity": "A String", # Output only. Harm severity levels in the content.
+          "severityScore": 3.14, # Output only. Harm severity score.
+        },
+      ],
+    },
+  ],
+  "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.
+    "blockReason": "A String", # Output only. Blocked reason.
+    "blockReasonMessage": "A String", # Output only. A readable block reason message.
+    "safetyRatings": [ # Output only. Safety ratings.
+      { # Safety rating corresponding to the generated content.
+        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
+        "category": "A String", # Output only. Harm category.
+        "probability": "A String", # Output only. Harm probability levels in the content.
+        "probabilityScore": 3.14, # Output only. Harm probability score.
+        "severity": "A String", # Output only. Harm severity levels in the content.
+        "severityScore": 3.14, # Output only. Harm severity score.
+      },
+    ],
+  },
+  "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s).
+    "candidatesTokenCount": 42, # Number of tokens in the response(s).
+    "promptTokenCount": 42, # Number of tokens in the request.
+    "totalTokenCount": 42,
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 075877e6f39..ce9dbb0a927 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -600,6 +600,7 @@ ## firebaseml * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/firebaseml_v1.html) * [v1beta2](http://googleapis.github.io/google-api-python-client/docs/dyn/firebaseml_v1beta2.html) +* [v2beta](http://googleapis.github.io/google-api-python-client/docs/dyn/firebaseml_v2beta.html) ## firebaserules diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.html index 013c2d312d6..d5961355cb8 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.integrations.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.html @@ -426,7 +426,9 @@

Method Details

"integrations": [ # The integrations which match the request. { # The integration definition. "active": True or False, # Required. If any integration version is published. + "creatorEmail": "A String", # Output only. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call. "description": "A String", # Optional. + "lastModifierEmail": "A String", # Required. The last modifier of this integration "name": "A String", # Required. The resource name of the integration. "updateTime": "A String", # Output only. Auto-generated. }, diff --git a/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html index 5976e275dba..7c65e58ce7d 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.integrations.versions.html @@ -384,6 +384,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -1393,6 +1394,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -2460,6 +2462,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -3481,6 +3484,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -4508,6 +4512,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -5516,6 +5521,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -6564,6 +6570,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -7612,6 +7619,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html index d572c9bf1c9..4ec5c186a12 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.html @@ -402,7 +402,9 @@

Method Details

"integrations": [ # The integrations which match the request. { # The integration definition. "active": True or False, # Required. If any integration version is published. + "creatorEmail": "A String", # Output only. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call. "description": "A String", # Optional. + "lastModifierEmail": "A String", # Required. The last modifier of this integration "name": "A String", # Required. The resource name of the integration. "updateTime": "A String", # Output only. Auto-generated. }, diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html index 58a76595548..f6f497f8b22 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrations.versions.html @@ -384,6 +384,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -1393,6 +1394,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -2460,6 +2462,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -3481,6 +3484,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -4508,6 +4512,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -5516,6 +5521,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -6564,6 +6570,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -7612,6 +7619,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, diff --git a/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html index 9d8f6242383..1bf96d198bd 100644 --- a/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html +++ b/docs/dyn/integrations_v1alpha.projects.locations.products.integrationtemplates.versions.html @@ -701,6 +701,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -1466,6 +1467,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -2238,6 +2240,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, @@ -3015,6 +3018,7 @@

Method Details

"producer": "A String", "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type. "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry". + "required": True or False, }, ], }, diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html index 283c95dfd40..05e24f3b2c3 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html @@ -233,6 +233,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -374,6 +375,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -508,6 +510,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -663,6 +666,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -839,6 +843,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -974,6 +979,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -1108,6 +1114,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. @@ -1255,6 +1262,7 @@

Method Details

"promotions": [ # Optional. Deprecated: consider using the top-level `promotion_specs` as the input. Optional. Resource name that identifies one or more promotions that can be applied on the product. A typical promotion for a subscription is Free trial. The format will be 'partners/{partner_id}/promotions/{promotion_id}'. "A String", ], + "purchaseTime": "A String", # Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of "bundle with choice", and it must be before the provision_time (when the user makes a selection). "redirectUri": "A String", # Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty. "renewalTime": "A String", # Output only. The time at which the subscription is expected to be renewed by Google - a new charge will be incurred and the service entitlement will be renewed. A non-immediate cancellation will take place at this time too, before which, the service entitlement for the end user will remain valid. UTC timezone in ISO 8061 format. For example: "2019-08-31T17:28:54.564Z" "serviceLocation": { # Describes a location of an end user. # Required. The location that the service is provided as indicated by the partner. diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index fd040405109..602929166d6 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -229,7 +229,7 @@

Method Details

"text": "A String", # Text that may be used as is or formatted with `matches`. }, }, - "text": { # Text representing a Place or query prediction. The text may be used as is or formatted. # The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, TextSearch). `text` is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. They are two different ways to represent a query prediction. Users should not try to parse `structured_format` into `text` or vice versa. May be in mixed languages if the request `input` and `language_code` are in different languages or if part of the query does not have a translation from the local language to `language_code`. + "text": { # Text representing a Place or query prediction. The text may be used as is or formatted. # The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, Text Search). `text` is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. They are two different ways to represent a query prediction. Users should not try to parse `structured_format` into `text` or vice versa. May be in mixed languages if the request `input` and `language_code` are in different languages or if part of the query does not have a translation from the local language to `language_code`. "matches": [ # A list of string ranges identifying where the input request matched in `text`. The ranges can be used to format specific parts of `text`. The substrings may not be exact matches of `input` if the matching was determined by criteria other than string matching (for example, spell corrections or transliterations). These values are Unicode character offsets of `text`. The ranges are guaranteed to be ordered in increasing offset values. { # Identifies a substring within a given text. "endOffset": 42, # Zero-based offset of the last Unicode character (exclusive). diff --git a/docs/dyn/trafficdirector_v3.discovery.html b/docs/dyn/trafficdirector_v3.discovery.html index b6bcf30b83f..37fc6f90c1c 100644 --- a/docs/dyn/trafficdirector_v3.discovery.html +++ b/docs/dyn/trafficdirector_v3.discovery.html @@ -168,8 +168,14 @@

Method Details

}, "nodeMatchers": [ # Management server can use these match criteria to identify clients. The match follows OR semantics. { # Specifies the way to match a Node. The match follows AND semantics. - "nodeId": { # Specifies the way to match a string. [#next-free-field: 8] # Specifies match criteria on the node id. + "nodeId": { # Specifies the way to match a string. [#next-free-field: 9] # Specifies match criteria on the node id. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "custom": { # Message type for extension configuration. # Use an extension as the matcher type. [#extension-category: envoy.string_matcher] + "name": "A String", # The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier. + "typedConfig": { # The typed config for the extension. The type URL will be used to identify the extension. In the case that the type URL is *xds.type.v3.TypedStruct* (or, for historical reasons, *udpa.type.v1.TypedStruct*), the inner type URL of *TypedStruct* will be utilized. See the :ref:`extension configuration overview ` for further details. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + }, "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. This has no effect for the safe_regex match. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` @@ -208,8 +214,14 @@

Method Details

], }, "presentMatch": True or False, # If specified, value match will be performed based on whether the path is referring to a valid primitive value in the metadata. If the path is referring to a non-primitive value, the result is always not matched. - "stringMatch": { # Specifies the way to match a string. [#next-free-field: 8] # If specified, a match occurs if and only if the target value is a string value and is matched to this field. + "stringMatch": { # Specifies the way to match a string. [#next-free-field: 9] # If specified, a match occurs if and only if the target value is a string value and is matched to this field. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "custom": { # Message type for extension configuration. # Use an extension as the matcher type. [#extension-category: envoy.string_matcher] + "name": "A String", # The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier. + "typedConfig": { # The typed config for the extension. The type URL will be used to identify the extension. In the case that the type URL is *xds.type.v3.TypedStruct* (or, for historical reasons, *udpa.type.v1.TypedStruct*), the inner type URL of *TypedStruct* will be utilized. See the :ref:`extension configuration overview ` for further details. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + }, "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. This has no effect for the safe_regex match. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` diff --git a/docs/dyn/verifiedaccess_v2.challenge.html b/docs/dyn/verifiedaccess_v2.challenge.html index 0f7a3994ad2..f573a2b7b1b 100644 --- a/docs/dyn/verifiedaccess_v2.challenge.html +++ b/docs/dyn/verifiedaccess_v2.challenge.html @@ -174,6 +174,7 @@

Method Details

"profileAffiliationIds": [ # Affiliation IDs of the organizations that are affiliated with the organization that is currently managing the Chrome Profile’s user or ChromeOS user. "A String", ], + "profileEnrollmentDomain": "A String", # Enrollment domain of the customer which is currently managing the profile. "realtimeUrlCheckMode": "A String", # Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode "safeBrowsingProtectionLevel": "A String", # Safe Browsing Protection Level. That setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#SafeBrowsingProtectionLevel. "screenLockSecured": "A String", # The state of the Screen Lock password protection. On ChromeOS, this value will always be ENABLED as there is not way to disable requiring a password or pin when unlocking the device. diff --git a/docs/dyn/workspaceevents_v1.subscriptions.html b/docs/dyn/workspaceevents_v1.subscriptions.html index 027c0e7767c..ab53afc91a4 100644 --- a/docs/dyn/workspaceevents_v1.subscriptions.html +++ b/docs/dyn/workspaceevents_v1.subscriptions.html @@ -340,7 +340,7 @@

Method Details

"updateTime": "A String", # Output only. The last time that the subscription is updated. } - updateMask: string, Optional. Required. The field to update. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to-live (TTL) or duration of the subscription. + updateMask: string, Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to-live (TTL) or duration of the subscription. To fully replace the subscription (the equivalent of `PUT`), use `*`. Any omitted fields are updated with empty values. validateOnly: boolean, Optional. If set to `true`, validates and previews the request, but doesn't update the subscription. x__xgafv: string, V1 error format. Allowed values diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index 66232f890d9..01beb082b5a 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/googleapiclient/discovery_cache/documents/acmedns.v1.json b/googleapiclient/discovery_cache/documents/acmedns.v1.json index 6e32afeee3e..6622a645c81 100644 --- a/googleapiclient/discovery_cache/documents/acmedns.v1.json +++ b/googleapiclient/discovery_cache/documents/acmedns.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://acmedns.googleapis.com/", "schemas": { "AcmeChallengeSet": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 3b88a470ae4..1040b265b3e 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -3115,7 +3115,7 @@ } } }, -"revision": "20240327", +"revision": "20240408", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json index 9e4746b7c07..2cd50bbfdda 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json @@ -272,7 +272,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 55b669cd3c5..99b1f869e8b 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4671,7 +4671,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index 805f0827b45..0860fd76f0e 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -626,7 +626,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index 04a93b331e2..b3c4de37889 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20240401", +"revision": "20240408", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index e73bbe1a789..1a0a4d28fc7 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -758,7 +758,7 @@ } } }, -"revision": "20240401", +"revision": "20240408", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index ec9c3bff629..a750aaf7432 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1912,7 +1912,7 @@ } } }, -"revision": "20240326", +"revision": "20240408", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json b/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json index ad0a4ed4372..683166ef3ee 100644 --- a/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/advisorynotifications.v1.json @@ -119,7 +119,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.", +"description": "Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/settings$", "required": true, @@ -144,7 +144,7 @@ ], "parameters": { "name": { -"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.", +"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/settings$", "required": true, @@ -222,7 +222,7 @@ "type": "string" }, "parent": { -"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\"", +"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\".", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -261,6 +261,61 @@ "projects": { "resources": { "locations": { +"methods": { +"getSettings": { +"description": "Get notification settings.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", +"httpMethod": "GET", +"id": "advisorynotifications.projects.locations.getSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/settings$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAdvisorynotificationsV1Settings" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"updateSettings": { +"description": "Update notification settings.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", +"httpMethod": "PATCH", +"id": "advisorynotifications.projects.locations.updateSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/settings$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAdvisorynotificationsV1Settings" +}, +"response": { +"$ref": "GoogleCloudAdvisorynotificationsV1Settings" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "notifications": { "methods": { @@ -320,7 +375,7 @@ "type": "string" }, "parent": { -"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\"", +"description": "Required. The parent, which owns this collection of notifications. Must be of the form \"organizations/{organization}/locations/{location}\" or \"projects/{project}/locations/{location}\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -357,7 +412,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://advisorynotifications.googleapis.com/", "schemas": { "GoogleCloudAdvisorynotificationsV1Attachment": { @@ -538,7 +593,7 @@ "type": "string" }, "name": { -"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.", +"description": "Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.", "type": "string" }, "notificationSettings": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 45bf9add9bb..b7ace75f09f 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -15922,6 +15922,130 @@ } }, "tuningJobs": { +"methods": { +"cancel": { +"description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/tuningJobs", +"request": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a TuningJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists TuningJobs in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The standard list filter.", +"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 ListTuningJob.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/tuningJobs", +"response": { +"$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -16080,7 +16204,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -16677,6 +16801,10 @@ "CloudAiNlLlmProtoServiceMessageMetadata": { "id": "CloudAiNlLlmProtoServiceMessageMetadata", "properties": { +"factualityDebugMetadata": { +"$ref": "LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata", +"description": "Factuality-related debug metadata." +}, "inputFilterInfo": { "$ref": "LearningServingLlmMessageMetadata", "description": "Filter metadata of the input messages." @@ -16885,6 +17013,13 @@ }, "type": "array" }, +"translationRequestInfos": { +"description": "Translation request info during RAI for debugging purpose. Each TranslationRequestInfo corresponds to a request sent to the translation server.", +"items": { +"$ref": "LearningGenaiRootTranslationRequestInfo" +}, +"type": "array" +}, "triggeredBlocklist": { "description": "Whether the text triggered the blocklist.", "type": "boolean" @@ -18339,6 +18474,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudAiplatformV1CancelTuningJobRequest": { +"description": "Request message for GenAiTuningService.CancelTuningJob.", +"id": "GoogleCloudAiplatformV1CancelTuningJobRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1Candidate": { "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1Candidate", @@ -22465,7 +22606,7 @@ "type": "object" }, "GoogleCloudAiplatformV1FindNeighborsRequest": { -"description": "LINT.IfChange The request message for MatchService.FindNeighbors.", +"description": "The request message for MatchService.FindNeighbors.", "id": "GoogleCloudAiplatformV1FindNeighborsRequest", "properties": { "deployedIndexId": { @@ -22813,6 +22954,10 @@ "format": "float", "type": "number" }, +"responseMimeType": { +"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", +"type": "string" +}, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -22937,13 +23082,6 @@ }, "type": "array" }, -"retrievalQueries": { -"description": "Optional. Queries executed by the retrieval tools.", -"items": { -"type": "string" -}, -"type": "array" -}, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -24578,6 +24716,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListTuningJobsResponse": { +"description": "Response message for GenAiTuningService.ListTuningJobs", +"id": "GoogleCloudAiplatformV1ListTuningJobsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass to ListTuningJobsRequest.page_token to obtain that page.", +"type": "string" +}, +"tuningJobs": { +"description": "List of TuningJobs in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1TuningJob" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1LookupStudyRequest": { "description": "Request message for VizierService.LookupStudy.", "id": "GoogleCloudAiplatformV1LookupStudyRequest", @@ -26733,7 +26889,8 @@ "OP_IN_DATAPOINT", "MULTIPLE_VALUES", "INVALID_NUMERIC_VALUE", -"INVALID_ENCODING" +"INVALID_ENCODING", +"INVALID_SPARSE_DIMENSIONS" ], "enumDescriptions": [ "Default, shall not be used.", @@ -26749,7 +26906,8 @@ "Numeric restrict has operator specified in datapoint.", "Numeric restrict has multiple values specified.", "Numeric restrict has invalid numeric value specified.", -"File is not in UTF_8 format." +"File is not in UTF_8 format.", +"Error parsing sparse dimensions field." ], "type": "string" }, @@ -28153,10 +28311,6 @@ "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, -"multiDeployVertex": { -"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", -"description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint." -}, "openEvaluationPipeline": { "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open evaluation pipeline of the PublisherModel." @@ -28257,20 +28411,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex": { -"description": "Multiple setups to deploy the PublisherModel.", -"id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployVertex", -"properties": { -"multiDeployVertex": { -"description": "Optional. One click deployment configurations.", -"items": { -"$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeploy" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines": { "description": "Open fine tuning pipelines.", "id": "GoogleCloudAiplatformV1PublisherModelCallToActionOpenFineTuningPipelines", @@ -28605,41 +28745,10 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1RayMetricSpec": { -"description": "Configuration for the Ray metrics.", -"id": "GoogleCloudAiplatformV1RayMetricSpec", -"properties": { -"disabled": { -"description": "Optional. Flag to disable the Ray metrics collection.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1RaySpec": { "description": "Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes.", "id": "GoogleCloudAiplatformV1RaySpec", -"properties": { -"headNodeResourcePoolId": { -"description": "Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.", -"type": "string" -}, -"imageUri": { -"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" -}, -"rayMetricSpec": { -"$ref": "GoogleCloudAiplatformV1RayMetricSpec", -"description": "Optional. Ray metrics configurations." -}, -"resourcePoolImages": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { \"ray_head_node_pool\": \"head image\" \"ray_worker_node_pool1\": \"worker image\" \"ray_worker_node_pool2\": \"another worker image\" }", -"type": "object" -} -}, +"properties": {}, "type": "object" }, "GoogleCloudAiplatformV1ReadFeatureValuesRequest": { @@ -28962,21 +29071,7 @@ "GoogleCloudAiplatformV1ResourceRuntime": { "description": "Persistent Cluster runtime information as output", "id": "GoogleCloudAiplatformV1ResourceRuntime", -"properties": { -"accessUris": { -"additionalProperties": { -"type": "string" -}, -"description": "Output only. URIs for user to connect to the Cluster. Example: { \"RAY_HEAD_NODE_INTERNAL_IP\": \"head-node-IP:10001\" \"RAY_DASHBOARD_URI\": \"ray-dashboard-address:8888\" }", -"readOnly": true, -"type": "object" -}, -"notebookRuntimeTemplate": { -"description": "Output only. The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: \"projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123\"", -"readOnly": true, -"type": "string" -} -}, +"properties": {}, "type": "object" }, "GoogleCloudAiplatformV1ResourceRuntimeSpec": { @@ -30140,6 +30235,78 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics": { +"description": "Metrics for general pairwise text generation evaluation results.", +"id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics", +"properties": { +"accuracy": { +"description": "Fraction of cases where the autorater agreed with the human raters.", +"format": "float", +"type": "number" +}, +"baselineModelWinRate": { +"description": "Percentage of time the autorater decided the baseline model had the better response.", +"format": "float", +"type": "number" +}, +"cohensKappa": { +"description": "A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account.", +"format": "float", +"type": "number" +}, +"f1Score": { +"description": "Harmonic mean of precision and recall.", +"format": "float", +"type": "number" +}, +"falseNegativeCount": { +"description": "Number of examples where the autorater chose the baseline model, but humans preferred the model.", +"format": "int64", +"type": "string" +}, +"falsePositiveCount": { +"description": "Number of examples where the autorater chose the model, but humans preferred the baseline model.", +"format": "int64", +"type": "string" +}, +"humanPreferenceBaselineModelWinRate": { +"description": "Percentage of time humans decided the baseline model had the better response.", +"format": "float", +"type": "number" +}, +"humanPreferenceModelWinRate": { +"description": "Percentage of time humans decided the model had the better response.", +"format": "float", +"type": "number" +}, +"modelWinRate": { +"description": "Percentage of time the autorater decided the model had the better response.", +"format": "float", +"type": "number" +}, +"precision": { +"description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the autorater thought the model had a better response. True positive divided by all positive.", +"format": "float", +"type": "number" +}, +"recall": { +"description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the humans thought the model had a better response.", +"format": "float", +"type": "number" +}, +"trueNegativeCount": { +"description": "Number of examples where both the autorater and humans decided that the model had the worse response.", +"format": "int64", +"type": "string" +}, +"truePositiveCount": { +"description": "Number of examples where both the autorater and humans decided that the model had the better response.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics": { "id": "GoogleCloudAiplatformV1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics", "properties": { @@ -33501,7 +33668,7 @@ false "type": "boolean" }, "serviceAccount": { -"description": "Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.", +"description": "Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job.", "type": "string" } }, @@ -34276,6 +34443,196 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SupervisedHyperParameters": { +"description": "Hyperparameters for SFT.", +"id": "GoogleCloudAiplatformV1SupervisedHyperParameters", +"properties": { +"adapterSize": { +"description": "Optional. Adapter size for tuning.", +"enum": [ +"ADAPTER_SIZE_UNSPECIFIED", +"ADAPTER_SIZE_ONE", +"ADAPTER_SIZE_FOUR", +"ADAPTER_SIZE_EIGHT", +"ADAPTER_SIZE_SIXTEEN" +], +"enumDescriptions": [ +"Adapter size is unspecified.", +"Adapter size 1.", +"Adapter size 4.", +"Adapter size 8.", +"Adapter size 16." +], +"type": "string" +}, +"epochCount": { +"description": "Optional. Number of training epoches for this tuning job.", +"format": "int64", +"type": "string" +}, +"learningRateMultiplier": { +"description": "Optional. Learning rate multiplier for tuning.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SupervisedTuningDataStats": { +"description": "Tuning data statistics for Supervised Tuning.", +"id": "GoogleCloudAiplatformV1SupervisedTuningDataStats", +"properties": { +"totalBillableCharacterCount": { +"description": "Output only. Number of billable characters in the tuning dataset.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"totalTuningCharacterCount": { +"description": "Output only. Number of tuning characters in the tuning dataset.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"tuningDatasetExampleCount": { +"description": "Output only. Number of examples in the tuning dataset.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"tuningStepCount": { +"description": "Output only. Number of tuning steps for this Tuning Job.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"userDatasetExamples": { +"description": "Output only. Sample user messages in the training dataset uri.", +"items": { +"$ref": "GoogleCloudAiplatformV1Content" +}, +"readOnly": true, +"type": "array" +}, +"userInputTokenDistribution": { +"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", +"description": "Output only. Dataset distributions for the user input tokens.", +"readOnly": true +}, +"userMessagePerExampleDistribution": { +"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", +"description": "Output only. Dataset distributions for the messages per example.", +"readOnly": true +}, +"userOutputTokenDistribution": { +"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", +"description": "Output only. Dataset distributions for the user output tokens.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution": { +"description": "Dataset distribution for Supervised Tuning.", +"id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", +"properties": { +"buckets": { +"description": "Output only. Defines the histogram bucket.", +"items": { +"$ref": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket" +}, +"readOnly": true, +"type": "array" +}, +"max": { +"description": "Output only. The maximum of the population values.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"mean": { +"description": "Output only. The arithmetic mean of the values in the population.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"median": { +"description": "Output only. The median of the values in the population.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"min": { +"description": "Output only. The minimum of the population values.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"p5": { +"description": "Output only. The 5th percentile of the values in the population.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"p95": { +"description": "Output only. The 95th percentile of the values in the population.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"sum": { +"description": "Output only. Sum of a given population of values.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket": { +"description": "Dataset bucket used to create a histogram for the distribution given a population of values.", +"id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistributionDatasetBucket", +"properties": { +"count": { +"description": "Output only. Number of values in the bucket.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"left": { +"description": "Output only. Left bound of the bucket.", +"format": "double", +"readOnly": true, +"type": "number" +}, +"right": { +"description": "Output only. Right bound of the bucket.", +"format": "double", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1SupervisedTuningSpec": { +"description": "Tuning Spec for Supervised Tuning.", +"id": "GoogleCloudAiplatformV1SupervisedTuningSpec", +"properties": { +"hyperParameters": { +"$ref": "GoogleCloudAiplatformV1SupervisedHyperParameters", +"description": "Optional. Hyperparameters for SFT." +}, +"trainingDatasetUri": { +"description": "Required. Cloud Storage path to file containing training dataset for tuning.", +"type": "string" +}, +"validationDatasetUri": { +"description": "Optional. Cloud Storage path to file containing validation dataset for tuning.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1SyncFeatureViewRequest": { "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1SyncFeatureViewRequest", @@ -35132,6 +35489,146 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1TunedModel": { +"description": "The Model Registry Model and Online Prediction Endpoint assiociated with this TuningJob.", +"id": "GoogleCloudAiplatformV1TunedModel", +"properties": { +"endpoint": { +"description": "Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.", +"readOnly": true, +"type": "string" +}, +"model": { +"description": "Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1TuningDataStats": { +"description": "The tuning data statistic values for TuningJob.", +"id": "GoogleCloudAiplatformV1TuningDataStats", +"properties": { +"supervisedTuningDataStats": { +"$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats", +"description": "The SFT Tuning data stats." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1TuningJob": { +"description": "Represents a TuningJob that runs with Google owned models.", +"id": "GoogleCloudAiplatformV1TuningJob", +"properties": { +"baseModel": { +"description": "Model name for tuning, e.g., \"gemini-1.0-pro-002\".", +"type": "string" +}, +"createTime": { +"description": "Output only. Time when the TuningJob was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The description of the TuningJob.", +"type": "string" +}, +"endTime": { +"description": "Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", +"readOnly": true +}, +"experiment": { +"description": "Output only. The Experiment associated with this TuningJob.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.", +"type": "object" +}, +"name": { +"description": "Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", +"readOnly": true, +"type": "string" +}, +"startTime": { +"description": "Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The detailed state of the job.", +"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" +}, +"supervisedTuningSpec": { +"$ref": "GoogleCloudAiplatformV1SupervisedTuningSpec", +"description": "Tuning Spec for Supervised Fine Tuning." +}, +"tunedModel": { +"$ref": "GoogleCloudAiplatformV1TunedModel", +"description": "Output only. The tuned model resources assiociated with this TuningJob.", +"readOnly": true +}, +"tunedModelDisplayName": { +"description": "Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"type": "string" +}, +"tuningDataStats": { +"$ref": "GoogleCloudAiplatformV1TuningDataStats", +"description": "Output only. The tuning data statistics associated with this TuningJob.", +"readOnly": true +}, +"updateTime": { +"description": "Output only. Time when the TuningJob was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1UndeployIndexOperationMetadata": { "description": "Runtime operation information for IndexEndpointService.UndeployIndex.", "id": "GoogleCloudAiplatformV1UndeployIndexOperationMetadata", @@ -36434,7 +36931,13 @@ false "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -36761,6 +37264,12 @@ false "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -37202,7 +37711,13 @@ false "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -37529,6 +38044,12 @@ false "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -37981,7 +38502,13 @@ false "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -38101,7 +38628,7 @@ false "", "", "", -"Github Github dataset with license info. We prefer this to help cite proper licenses for code recitation.", +"GitHub dataset with license info. We prefer this to help cite proper licenses for code recitation.", "", "", "", @@ -38308,6 +38835,12 @@ false "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -38749,7 +39282,13 @@ false "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -38869,7 +39408,7 @@ false "", "", "", -"Github Github dataset with license info. We prefer this to help cite proper licenses for code recitation.", +"GitHub dataset with license info. We prefer this to help cite proper licenses for code recitation.", "", "", "", @@ -39076,6 +39615,12 @@ false "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -39920,6 +40465,25 @@ false }, "type": "object" }, +"LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata": { +"id": "LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata", +"properties": { +"factRetrievalMillisecondsByProvider": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Latency spent on fact retrievals. There might be multiple retrievals from different fact providers.", +"type": "object" +}, +"prompt2queryMilliseconds": { +"description": "Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "LearningGenaiRootRAIOutput": { "description": "This is per harm.", "id": "LearningGenaiRootRAIOutput", @@ -40381,6 +40945,25 @@ false }, "type": "object" }, +"LearningGenaiRootTranslationRequestInfo": { +"description": "Each TranslationRequestInfo corresponds to a request sent to the translation server.", +"id": "LearningGenaiRootTranslationRequestInfo", +"properties": { +"detectedLanguageCodes": { +"description": "The ISO-639 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.", +"items": { +"type": "string" +}, +"type": "array" +}, +"totalContentSize": { +"description": "The sum of the size of all the contents in the request.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "LearningServingLlmMessageMetadata": { "description": "LINT.IfChange This metadata contains additional information required for debugging.", "id": "LearningServingLlmMessageMetadata", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 94dceeecaa7..702075c9c62 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -305,51 +305,62 @@ }, "protocol": "rest", "resources": { -"media": { +"projects": { "methods": { -"upload": { -"description": "Upload a file into a RagCorpus.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload", -"httpMethod": "POST", -"id": "aiplatform.media.upload", -"mediaUpload": { -"accept": [ -"*/*" +"getCacheConfig": { +"description": "Gets a GenAI cache config.", +"flatPath": "v1beta1/projects/{projectsId}/cacheConfig", +"httpMethod": "GET", +"id": "aiplatform.projects.getCacheConfig", +"parameterOrder": [ +"name" ], -"protocols": { -"simple": { -"multipart": true, -"path": "/upload/v1beta1/{+parent}/ragFiles:upload" -} +"parameters": { +"name": { +"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/cacheConfig$", +"required": true, +"type": "string" } }, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1CacheConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"updateCacheConfig": { +"description": "Updates a cache config.", +"flatPath": "v1beta1/projects/{projectsId}/cacheConfig", +"httpMethod": "PATCH", +"id": "aiplatform.projects.updateCacheConfig", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", +"name": { +"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", +"pattern": "^projects/[^/]+/cacheConfig$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/ragFiles:upload", +"path": "v1beta1/{+name}", "request": { -"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest" +"$ref": "GoogleCloudAiplatformV1beta1CacheConfig" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" -], -"supportsMediaUpload": true -} +] } }, -"projects": { "resources": { "locations": { "methods": { @@ -446,34 +457,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"retrieveContexts": { -"description": "Retrieves relevant contexts for a query.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.retrieveContexts", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}:retrieveContexts", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } }, "resources": { @@ -3828,6 +3811,38 @@ } }, "resources": { +"chat": { +"methods": { +"completions": { +"description": "Exposes an OpenAI-compatible endpoint for chat completions.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.chat.completions", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/openapi`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+endpoint}/chat/completions", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -14339,127 +14354,6 @@ } }, "ragCorpora": { -"methods": { -"create": { -"description": "Creates a RagCorpus.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.ragCorpora.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/ragCorpora", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1RagCorpus" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a RagCorpus.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.ragCorpora.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"force": { -"description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.", -"location": "query", -"type": "boolean" -}, -"name": { -"description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets a RagCorpus.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.ragCorpora.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1RagCorpus" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists RagCorpora in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.ragCorpora.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"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 ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/ragCorpora", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, "resources": { "operations": { "methods": { @@ -14613,122 +14507,6 @@ } }, "ragFiles": { -"methods": { -"delete": { -"description": "Deletes a RagFile.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets a RagFile.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.ragCorpora.ragFiles.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1RagFile" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"import": { -"description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.ragCorpora.ragFiles.import", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/ragFiles:import", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists RagFiles in a RagCorpus.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.ragCorpora.ragFiles.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"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 ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/ragFiles", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, "resources": { "operations": { "methods": { @@ -18738,7 +18516,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionEmbedVideoResponse": { @@ -19335,6 +19113,10 @@ "CloudAiNlLlmProtoServiceMessageMetadata": { "id": "CloudAiNlLlmProtoServiceMessageMetadata", "properties": { +"factualityDebugMetadata": { +"$ref": "LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata", +"description": "Factuality-related debug metadata." +}, "inputFilterInfo": { "$ref": "LearningServingLlmMessageMetadata", "description": "Filter metadata of the input messages." @@ -19543,6 +19325,13 @@ }, "type": "array" }, +"translationRequestInfos": { +"description": "Translation request info during RAI for debugging purpose. Each TranslationRequestInfo corresponds to a request sent to the translation server.", +"items": { +"$ref": "LearningGenaiRootTranslationRequestInfo" +}, +"type": "array" +}, "triggeredBlocklist": { "description": "Whether the text triggered the blocklist.", "type": "boolean" @@ -20243,12 +20032,12 @@ ], "enumDescriptions": [ "", -"", -"", -"", -"", -"", -"" +"No Auth.", +"API Key Auth.", +"HTTP Basic Auth.", +"Google Service Account Auth.", +"OAuth auth.", +"OpenID Connect (OIDC) Auth." ], "type": "string" }, @@ -20296,11 +20085,11 @@ ], "enumDescriptions": [ "", -"", -"", -"", -"", -"" +"Element is in the HTTP request query.", +"Element is in the HTTP request header.", +"Element is in the HTTP request path.", +"Element is in the HTTP request body.", +"Element is in the HTTP request cookie." ], "type": "string" }, @@ -21213,6 +21002,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1CacheConfig": { +"description": "Config of GenAI caching features. This is a singleton resource.", +"id": "GoogleCloudAiplatformV1beta1CacheConfig", +"properties": { +"disableCache": { +"description": "If set to true, disables GenAI caching. Otherwise caching is enabled.", +"type": "boolean" +}, +"name": { +"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest": { "description": "Request message for JobService.CancelBatchPredictionJob.", "id": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest", @@ -23137,12 +22941,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1DirectUploadSource": { -"description": "The input content is encapsulated and uploaded in the request.", -"id": "GoogleCloudAiplatformV1beta1DirectUploadSource", -"properties": {}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1DiskSpec": { "description": "Represents the spec of disk options.", "id": "GoogleCloudAiplatformV1beta1DiskSpec", @@ -23451,14 +23249,6 @@ "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceInput", "description": "Input for question answering relevance metric." }, -"ragContextRecallInput": { -"$ref": "GoogleCloudAiplatformV1beta1RagContextRecallInput", -"description": "Input for rag context recall metric." -}, -"responseRecallInput": { -"$ref": "GoogleCloudAiplatformV1beta1ResponseRecallInput", -"description": "Input for response recall metric." -}, "rougeInput": { "$ref": "GoogleCloudAiplatformV1beta1RougeInput", "description": "Instances and metric spec for rouge metric." @@ -23550,14 +23340,6 @@ "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringRelevanceResult", "description": "Result for question answering relevance metric." }, -"ragContextRecallResult": { -"$ref": "GoogleCloudAiplatformV1beta1RagContextRecallResult", -"description": "RAG only metrics. Result for context recall metric." -}, -"responseRecallResult": { -"$ref": "GoogleCloudAiplatformV1beta1ResponseRecallResult", -"description": "Result for response recall metric." -}, "rougeResults": { "$ref": "GoogleCloudAiplatformV1beta1RougeResults", "description": "Results for rouge metric." @@ -24773,6 +24555,14 @@ "description": "Identifier. The resource name of the Extension.", "type": "string" }, +"privateServiceConnectConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ExtensionPrivateServiceConnectConfig", +"description": "Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided Service Directory (https://cloud.google.com/service-directory/docs/configuring-private-network-access). If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution." +}, +"runtimeConfig": { +"$ref": "GoogleCloudAiplatformV1beta1RuntimeConfig", +"description": "Optional. Runtime config controlling the runtime behavior of this Extension." +}, "toolUseExamples": { "description": "Optional. Examples to illustrate the usage of the extension as a tool.", "items": { @@ -24843,6 +24633,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ExtensionPrivateServiceConnectConfig": { +"description": "PrivateExtensionConfig configuration for the extension.", +"id": "GoogleCloudAiplatformV1beta1ExtensionPrivateServiceConnectConfig", +"properties": { +"serviceDirectory": { +"description": "Required. The Service Directory resource name in which the service endpoints associated to the extension are registered. Format: `projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}` - The Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted `servicedirectory.viewer` and `servicedirectory.pscAuthorizedService` roles on the resource.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Feature": { "description": "Feature Metadata information. For example, color is a feature that describes an apple.", "id": "GoogleCloudAiplatformV1beta1Feature", @@ -26031,7 +25832,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FindNeighborsRequest": { -"description": "LINT.IfChange The request message for MatchService.FindNeighbors.", +"description": "The request message for MatchService.FindNeighbors.", "id": "GoogleCloudAiplatformV1beta1FindNeighborsRequest", "properties": { "deployedIndexId": { @@ -26580,6 +26381,10 @@ "format": "float", "type": "number" }, +"responseMimeType": { +"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: `text/plain`: (default) Text output. `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", +"type": "string" +}, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -26643,45 +26448,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GoogleDriveSource": { -"description": "The Google Drive location for the input content.", -"id": "GoogleCloudAiplatformV1beta1GoogleDriveSource", -"properties": { -"resourceIds": { -"description": "Required. Google Drive resource IDs.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId": { -"description": "The type and ID of the Google Drive resource.", -"id": "GoogleCloudAiplatformV1beta1GoogleDriveSourceResourceId", -"properties": { -"resourceId": { -"description": "Required. The ID of the Google Drive resource.", -"type": "string" -}, -"resourceType": { -"description": "Required. The type of the Google Drive resource.", -"enum": [ -"RESOURCE_TYPE_UNSPECIFIED", -"RESOURCE_TYPE_FILE", -"RESOURCE_TYPE_FOLDER" -], -"enumDescriptions": [ -"Unspecified resource type.", -"File resource type.", -"Folder resource type." -], -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -27200,36 +26966,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1ImportRagFilesConfig": { -"description": "Config for importing RagFiles.", -"id": "GoogleCloudAiplatformV1beta1ImportRagFilesConfig", -"properties": { -"gcsSource": { -"$ref": "GoogleCloudAiplatformV1beta1GcsSource", -"description": "Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: * \"gs://bucket_name/my_directory/object_name/my_file.txt\". * \"gs://bucket_name/my_directory\"" -}, -"googleDriveSource": { -"$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", -"description": "Google Drive location. Supports importing individual files as well as Google Drive folders." -}, -"ragFileChunkingConfig": { -"$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", -"description": "Specifies the size and overlap of chunks after importing RagFiles." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1ImportRagFilesRequest": { -"description": "Request message for VertexRagDataService.ImportRagFiles.", -"id": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest", -"properties": { -"importRagFilesConfig": { -"$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesConfig", -"description": "Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles." -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1Index": { "description": "A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.", "id": "GoogleCloudAiplatformV1beta1Index", @@ -28417,42 +28153,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1ListRagCorporaResponse": { -"description": "Response message for VertexRagDataService.ListRagCorpora.", -"id": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse", -"properties": { -"nextPageToken": { -"description": "A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.", -"type": "string" -}, -"ragCorpora": { -"description": "List of RagCorpora in the requested page.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1RagCorpus" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1ListRagFilesResponse": { -"description": "Response message for VertexRagDataService.ListRagFiles.", -"id": "GoogleCloudAiplatformV1beta1ListRagFilesResponse", -"properties": { -"nextPageToken": { -"description": "A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.", -"type": "string" -}, -"ragFiles": { -"description": "List of RagFiles in the requested page.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1RagFile" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse": { "description": "Response message for ReasoningEngineService.ListReasoningEngines", "id": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse", @@ -30803,7 +30503,8 @@ "OP_IN_DATAPOINT", "MULTIPLE_VALUES", "INVALID_NUMERIC_VALUE", -"INVALID_ENCODING" +"INVALID_ENCODING", +"INVALID_SPARSE_DIMENSIONS" ], "enumDescriptions": [ "Default, shall not be used.", @@ -30819,7 +30520,8 @@ "Numeric restrict has operator specified in datapoint.", "Numeric restrict has multiple values specified.", "Numeric restrict has invalid numeric value specified.", -"File is not in UTF_8 format." +"File is not in UTF_8 format.", +"Error parsing sparse dimensions field." ], "type": "string" }, @@ -31267,7 +30969,7 @@ "type": "string" }, "context": { -"description": "Optional. Text to answer the question.", +"description": "Required. Text to answer the question.", "type": "string" }, "instruction": { @@ -32417,10 +32119,6 @@ "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke", "description": "Optional. Deploy PublisherModel to Google Kubernetes Engine." }, -"multiDeployVertex": { -"$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex", -"description": "Optional. Multiple setups to deploy the PublisherModel to Vertex Endpoint." -}, "openEvaluationPipeline": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionRegionalResourceReferences", "description": "Optional. Open evaluation pipeline of the PublisherModel." @@ -32521,20 +32219,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex": { -"description": "Multiple setups to deploy the PublisherModel.", -"id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployVertex", -"properties": { -"multiDeployVertex": { -"description": "Optional. One click deployment configurations.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeploy" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines": { "description": "Open fine tuning pipelines.", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionOpenFineTuningPipelines", @@ -33107,7 +32791,7 @@ "id": "GoogleCloudAiplatformV1beta1QuestionAnsweringQualityInstance", "properties": { "context": { -"description": "Optional. Text to answer the question.", +"description": "Required. Text to answer the question.", "type": "string" }, "instruction": { @@ -33243,239 +32927,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1RagContextRecallInput": { -"description": "Input for rag context recall metric.", -"id": "GoogleCloudAiplatformV1beta1RagContextRecallInput", -"properties": { -"instance": { -"$ref": "GoogleCloudAiplatformV1beta1RagContextRecallInstance", -"description": "Required. Rag context recall instance." -}, -"metricSpec": { -"$ref": "GoogleCloudAiplatformV1beta1RagContextRecallSpec", -"description": "Required. Spec for rag context recall metric." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagContextRecallInstance": { -"description": "Spec for rag context recall instance.", -"id": "GoogleCloudAiplatformV1beta1RagContextRecallInstance", -"properties": { -"context": { -"description": "Required. Retrieved facts from RAG pipeline as context to be evaluated.", -"type": "string" -}, -"reference": { -"description": "Required. Ground truth used to compare against the context.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagContextRecallResult": { -"description": "Spec for rag context recall result.", -"id": "GoogleCloudAiplatformV1beta1RagContextRecallResult", -"properties": { -"confidence": { -"description": "Output only. Confidence for rag context recall score.", -"format": "float", -"readOnly": true, -"type": "number" -}, -"explanation": { -"description": "Output only. Explanation for rag context recall score.", -"readOnly": true, -"type": "string" -}, -"score": { -"description": "Output only. RagContextRecall score.", -"format": "float", -"readOnly": true, -"type": "number" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagContextRecallSpec": { -"description": "Spec for rag context recall metric.", -"id": "GoogleCloudAiplatformV1beta1RagContextRecallSpec", -"properties": { -"version": { -"description": "Optional. Which version to use for evaluation.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagContexts": { -"description": "Relevant contexts for one query.", -"id": "GoogleCloudAiplatformV1beta1RagContexts", -"properties": { -"contexts": { -"description": "All its contexts.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1RagContextsContext" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagContextsContext": { -"description": "A context of the query.", -"id": "GoogleCloudAiplatformV1beta1RagContextsContext", -"properties": { -"distance": { -"description": "The distance between the query vector and the context text vector.", -"format": "double", -"type": "number" -}, -"sourceUri": { -"description": "For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.", -"type": "string" -}, -"text": { -"description": "The text chunk.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagCorpus": { -"description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.", -"id": "GoogleCloudAiplatformV1beta1RagCorpus", -"properties": { -"createTime": { -"description": "Output only. Timestamp when this RagCorpus was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. The description of the RagCorpus.", -"type": "string" -}, -"displayName": { -"description": "Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters.", -"type": "string" -}, -"name": { -"description": "Output only. The resource name of the RagCorpus.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. Timestamp when this RagCorpus was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagFile": { -"description": "A RagFile contains user data for chunking, embedding and indexing.", -"id": "GoogleCloudAiplatformV1beta1RagFile", -"properties": { -"createTime": { -"description": "Output only. Timestamp when this RagFile was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. The description of the RagFile.", -"type": "string" -}, -"directUploadSource": { -"$ref": "GoogleCloudAiplatformV1beta1DirectUploadSource", -"description": "Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.", -"readOnly": true -}, -"displayName": { -"description": "Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", -"type": "string" -}, -"gcsSource": { -"$ref": "GoogleCloudAiplatformV1beta1GcsSource", -"description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the GCS uri for now.", -"readOnly": true -}, -"googleDriveSource": { -"$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", -"description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", -"readOnly": true -}, -"name": { -"description": "Output only. The resource name of the RagFile.", -"readOnly": true, -"type": "string" -}, -"ragFileType": { -"description": "Output only. The type of the RagFile.", -"enum": [ -"RAG_FILE_TYPE_UNSPECIFIED", -"RAG_FILE_TYPE_TXT", -"RAG_FILE_TYPE_PDF" -], -"enumDescriptions": [ -"RagFile type is unspecified.", -"RagFile type is TXT.", -"RagFile type is PDF." -], -"readOnly": true, -"type": "string" -}, -"sizeBytes": { -"description": "Output only. The size of the RagFile in bytes.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. Timestamp when this RagFile was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagFileChunkingConfig": { -"description": "Specifies the size and overlap of chunks for RagFiles.", -"id": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", -"properties": { -"chunkOverlap": { -"description": "The overlap between chunks.", -"format": "int32", -"type": "integer" -}, -"chunkSize": { -"description": "The size of the chunks.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RagQuery": { -"description": "A query to retrieve relevant contexts.", -"id": "GoogleCloudAiplatformV1beta1RagQuery", -"properties": { -"similarityTopK": { -"description": "Optional. The number of contexts to retrieve.", -"format": "int32", -"type": "integer" -}, -"text": { -"description": "Optional. The query in text format to get relevant contexts.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", @@ -34068,72 +33519,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1ResponseRecallInput": { -"description": "Input for response recall metric.", -"id": "GoogleCloudAiplatformV1beta1ResponseRecallInput", -"properties": { -"instance": { -"$ref": "GoogleCloudAiplatformV1beta1ResponseRecallInstance", -"description": "Required. Response recall instance." -}, -"metricSpec": { -"$ref": "GoogleCloudAiplatformV1beta1ResponseRecallSpec", -"description": "Required. Spec for response recall score metric." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1ResponseRecallInstance": { -"description": "Spec for response recall instance.", -"id": "GoogleCloudAiplatformV1beta1ResponseRecallInstance", -"properties": { -"prediction": { -"description": "Required. Output of the evaluated model.", -"type": "string" -}, -"reference": { -"description": "Required. Ground truth used to compare against the prediction.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1ResponseRecallResult": { -"description": "Spec for response recall result.", -"id": "GoogleCloudAiplatformV1beta1ResponseRecallResult", -"properties": { -"confidence": { -"description": "Output only. Confidence for fulfillment score.", -"format": "float", -"readOnly": true, -"type": "number" -}, -"explanation": { -"description": "Output only. Explanation for response recall score.", -"readOnly": true, -"type": "string" -}, -"score": { -"description": "Output only. ResponseRecall score.", -"format": "float", -"readOnly": true, -"type": "number" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1ResponseRecallSpec": { -"description": "Spec for response recall metric.", -"id": "GoogleCloudAiplatformV1beta1ResponseRecallSpec", -"properties": { -"version": { -"description": "Optional. Which version to use for evaluation.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1RestoreDatasetVersionOperationMetadata": { "description": "Runtime operation information for DatasetService.RestoreDatasetVersion.", "id": "GoogleCloudAiplatformV1beta1RestoreDatasetVersionOperationMetadata", @@ -34181,46 +33566,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1RetrieveContextsRequest": { -"description": "Request message for VertexRagService.RetrieveContexts.", -"id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest", -"properties": { -"query": { -"$ref": "GoogleCloudAiplatformV1beta1RagQuery", -"description": "Required. Single RAG retrieve query." -}, -"vertexRagStore": { -"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore", -"description": "The data source for Vertex RagStore." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore": { -"description": "The data source for Vertex RagStore.", -"id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStore", -"properties": { -"ragCorpora": { -"description": "Required. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1RetrieveContextsResponse": { -"description": "Response message for VertexRagService.RetrieveContexts.", -"id": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse", -"properties": { -"contexts": { -"$ref": "GoogleCloudAiplatformV1beta1RagContexts", -"description": "The contexts of the query." -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1RougeInput": { "description": "Input for rouge metric.", "id": "GoogleCloudAiplatformV1beta1RougeInput", @@ -34301,6 +33646,53 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RuntimeConfig": { +"description": "Runtime configuration to run the extension.", +"id": "GoogleCloudAiplatformV1beta1RuntimeConfig", +"properties": { +"codeInterpreterRuntimeConfig": { +"$ref": "GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig", +"description": "Code execution runtime configurations for code interpreter extension." +}, +"defaultParams": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time. The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param \"name\" to be set to \"abc\". you can set this to something like {\"name\": \"abc\"}.", +"type": "object" +}, +"vertexAiSearchRuntimeConfig": { +"$ref": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", +"description": "Runtime configuration for Vertext AI Search extension." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig": { +"id": "GoogleCloudAiplatformV1beta1RuntimeConfigCodeInterpreterRuntimeConfig", +"properties": { +"fileInputGcsBucket": { +"description": "Optional. The GCS bucket for file input of this Extension. If specified, support input from the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject GCS file inputs.", +"type": "string" +}, +"fileOutputGcsBucket": { +"description": "Optional. The GCS bucket for file output of this Extension. If specified, write all output files to the GCS bucket. Vertex Extension Custom Code Service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig": { +"id": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", +"properties": { +"servingConfigName": { +"description": "Required. Vertext AI Search serving config name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}` or `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SafetyInput": { "description": "Input for safety metric.", "id": "GoogleCloudAiplatformV1beta1SafetyInput", @@ -35453,6 +34845,78 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics": { +"description": "Metrics for general pairwise text generation evaluation results.", +"id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsPairwiseTextGenerationEvaluationMetrics", +"properties": { +"accuracy": { +"description": "Fraction of cases where the autorater agreed with the human raters.", +"format": "float", +"type": "number" +}, +"baselineModelWinRate": { +"description": "Percentage of time the autorater decided the baseline model had the better response.", +"format": "float", +"type": "number" +}, +"cohensKappa": { +"description": "A measurement of agreement between the autorater and human raters that takes the likelihood of random agreement into account.", +"format": "float", +"type": "number" +}, +"f1Score": { +"description": "Harmonic mean of precision and recall.", +"format": "float", +"type": "number" +}, +"falseNegativeCount": { +"description": "Number of examples where the autorater chose the baseline model, but humans preferred the model.", +"format": "int64", +"type": "string" +}, +"falsePositiveCount": { +"description": "Number of examples where the autorater chose the model, but humans preferred the baseline model.", +"format": "int64", +"type": "string" +}, +"humanPreferenceBaselineModelWinRate": { +"description": "Percentage of time humans decided the baseline model had the better response.", +"format": "float", +"type": "number" +}, +"humanPreferenceModelWinRate": { +"description": "Percentage of time humans decided the model had the better response.", +"format": "float", +"type": "number" +}, +"modelWinRate": { +"description": "Percentage of time the autorater decided the model had the better response.", +"format": "float", +"type": "number" +}, +"precision": { +"description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the autorater thought the model had a better response. True positive divided by all positive.", +"format": "float", +"type": "number" +}, +"recall": { +"description": "Fraction of cases where the autorater and humans thought the model had a better response out of all cases where the humans thought the model had a better response.", +"format": "float", +"type": "number" +}, +"trueNegativeCount": { +"description": "Number of examples where both the autorater and humans decided that the model had the worse response.", +"format": "int64", +"type": "string" +}, +"truePositiveCount": { +"description": "Number of examples where both the autorater and humans decided that the model had the better response.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics": { "id": "GoogleCloudAiplatformV1beta1SchemaModelevaluationMetricsQuestionAnsweringEvaluationMetrics", "properties": { @@ -38692,7 +38156,7 @@ "type": "boolean" }, "serviceAccount": { -"description": "Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.", +"description": "Optional. Required when all below conditions are met * `enable_custom_service_account` is true; * any runtime is specified via `ResourceRuntimeSpec` on creation time, for example, Ray The users must have `iam.serviceAccounts.actAs` permission on this service account and then the specified runtime containers will run as it. Do not set this field if you want to submit jobs using custom service account to this PersistentResource after creation, but only specify the `service_account` inside the job.", "type": "string" } }, @@ -41324,47 +40788,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1UploadRagFileConfig": { -"description": "Config for uploading RagFile.", -"id": "GoogleCloudAiplatformV1beta1UploadRagFileConfig", -"properties": { -"ragFileChunkingConfig": { -"$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", -"description": "Specifies the size and overlap of chunks after uploading RagFile." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1UploadRagFileRequest": { -"description": "Request message for VertexRagDataService.UploadRagFile.", -"id": "GoogleCloudAiplatformV1beta1UploadRagFileRequest", -"properties": { -"ragFile": { -"$ref": "GoogleCloudAiplatformV1beta1RagFile", -"description": "Required. The RagFile to upload." -}, -"uploadRagFileConfig": { -"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileConfig", -"description": "Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1UploadRagFileResponse": { -"description": "Response message for VertexRagDataService.UploadRagFile.", -"id": "GoogleCloudAiplatformV1beta1UploadRagFileResponse", -"properties": { -"error": { -"$ref": "GoogleRpcStatus", -"description": "The error that occurred while processing the RagFile." -}, -"ragFile": { -"$ref": "GoogleCloudAiplatformV1beta1RagFile", -"description": "The RagFile that had been uploaded into the RagCorpus." -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest": { "description": "Request message for IndexService.UpsertDatapoints", "id": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest", @@ -42407,7 +41830,13 @@ "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -42734,6 +42163,12 @@ "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -43175,7 +42610,13 @@ "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -43502,6 +42943,12 @@ "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -43954,7 +43401,13 @@ "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -44074,7 +43527,7 @@ "", "", "", -"Github Github dataset with license info. We prefer this to help cite proper licenses for code recitation.", +"GitHub dataset with license info. We prefer this to help cite proper licenses for code recitation.", "", "", "", @@ -44281,6 +43734,12 @@ "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -44722,7 +44181,13 @@ "CLOUD_GEMIT_AMPS", "CLOUD_GEMIT_AQUA", "CLOUD_GEMIT_COMMON_SENSE_REASONING_SCHEMA", -"CLOUD_GEMIT_GSM8K_SCHEMA" +"CLOUD_GEMIT_GSM8K_SCHEMA", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_UN", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_EUROPARL", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_WMT_NEWSCOMMENTARY", +"GEMINI_V1_TAIL_PATCH_TRANSLATION_2021_INCR", +"GEMINI_V1_TAIL_PATCH_GOALDMINE", +"GEMINI_V1_TAIL_PATCH_PHOTOMATH_IM2SOL_PROBLEM_AND_SOLUTION" ], "enumDescriptions": [ "", @@ -44842,7 +44307,7 @@ "", "", "", -"Github Github dataset with license info. We prefer this to help cite proper licenses for code recitation.", +"GitHub dataset with license info. We prefer this to help cite proper licenses for code recitation.", "", "", "", @@ -45049,6 +44514,12 @@ "", "", "", +"", +"Gemini V1 tail patch translation.", +"", +"", +"", +"Gemini V1 tail patch others.", "" ], "type": "string" @@ -45893,6 +45364,25 @@ false }, "type": "object" }, +"LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata": { +"id": "LearningGenaiRootPerRequestProcessorDebugMetadataFactualityDebugMetadata", +"properties": { +"factRetrievalMillisecondsByProvider": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Latency spent on fact retrievals. There might be multiple retrievals from different fact providers.", +"type": "object" +}, +"prompt2queryMilliseconds": { +"description": "Latency spent on prompt2query. The procedure generates a search-friendly query given the original prompt.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "LearningGenaiRootRAIOutput": { "description": "This is per harm.", "id": "LearningGenaiRootRAIOutput", @@ -46354,6 +45844,25 @@ false }, "type": "object" }, +"LearningGenaiRootTranslationRequestInfo": { +"description": "Each TranslationRequestInfo corresponds to a request sent to the translation server.", +"id": "LearningGenaiRootTranslationRequestInfo", +"properties": { +"detectedLanguageCodes": { +"description": "The ISO-639 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty.", +"items": { +"type": "string" +}, +"type": "array" +}, +"totalContentSize": { +"description": "The sum of the size of all the contents in the request.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "LearningServingLlmMessageMetadata": { "description": "LINT.IfChange This metadata contains additional information required for debugging.", "id": "LearningServingLlmMessageMetadata", diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index a3a78c0f34a..b99306cd938 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20240325", +"revision": "20240401", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 52585e809d5..dca5b72c48a 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -2089,8 +2089,10 @@ } }, "conversionEvents": { +"deprecated": true, "methods": { "create": { +"deprecated": true, "description": "Creates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", @@ -2119,6 +2121,7 @@ ] }, "delete": { +"deprecated": true, "description": "Deletes a conversion event in a property.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", @@ -2144,6 +2147,7 @@ ] }, "get": { +"deprecated": true, "description": "Retrieve a single conversion event.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", @@ -2170,6 +2174,7 @@ ] }, "list": { +"deprecated": true, "description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", @@ -2207,6 +2212,7 @@ ] }, "patch": { +"deprecated": true, "description": "Updates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", @@ -4026,6 +4032,160 @@ } } }, +"keyEvents": { +"methods": { +"create": { +"description": "Creates a Key Event.", +"flatPath": "v1alpha/properties/{propertiesId}/keyEvents", +"httpMethod": "POST", +"id": "analyticsadmin.properties.keyEvents.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the parent property where this Key Event will be created. Format: properties/123", +"location": "path", +"pattern": "^properties/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/keyEvents", +"request": { +"$ref": "GoogleAnalyticsAdminV1alphaKeyEvent" +}, +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaKeyEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +}, +"delete": { +"description": "Deletes a Key Event.", +"flatPath": "v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}", +"httpMethod": "DELETE", +"id": "analyticsadmin.properties.keyEvents.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"", +"location": "path", +"pattern": "^properties/[^/]+/keyEvents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +}, +"get": { +"description": "Retrieve a single Key Event.", +"flatPath": "v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}", +"httpMethod": "GET", +"id": "analyticsadmin.properties.keyEvents.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"", +"location": "path", +"pattern": "^properties/[^/]+/keyEvents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaKeyEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit", +"https://www.googleapis.com/auth/analytics.readonly" +] +}, +"list": { +"description": "Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.", +"flatPath": "v1alpha/properties/{propertiesId}/keyEvents", +"httpMethod": "GET", +"id": "analyticsadmin.properties.keyEvents.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent property. Example: 'properties/123'", +"location": "path", +"pattern": "^properties/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/keyEvents", +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaListKeyEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit", +"https://www.googleapis.com/auth/analytics.readonly" +] +}, +"patch": { +"description": "Updates a Key Event.", +"flatPath": "v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}", +"httpMethod": "PATCH", +"id": "analyticsadmin.properties.keyEvents.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}", +"location": "path", +"pattern": "^properties/[^/]+/keyEvents/[^/]+$", +"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": "GoogleAnalyticsAdminV1alphaKeyEvent" +}, +"response": { +"$ref": "GoogleAnalyticsAdminV1alphaKeyEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +} +} +}, "rollupPropertySourceLinks": { "methods": { "create": { @@ -4457,7 +4617,7 @@ } } }, -"revision": "20240329", +"revision": "20240405", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -7115,6 +7275,72 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1alphaKeyEvent": { +"description": "A key event in a Google Analytics property.", +"id": "GoogleAnalyticsAdminV1alphaKeyEvent", +"properties": { +"countingMethod": { +"description": "Required. The method by which Key Events will be counted across multiple events within a session.", +"enum": [ +"COUNTING_METHOD_UNSPECIFIED", +"ONCE_PER_EVENT", +"ONCE_PER_SESSION" +], +"enumDescriptions": [ +"Counting method not specified.", +"Each Event instance is considered a Key Event.", +"An Event instance is considered a Key Event at most once per session per user." +], +"type": "string" +}, +"createTime": { +"description": "Output only. Time when this key event was created in the property.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"custom": { +"description": "Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.", +"readOnly": true, +"type": "boolean" +}, +"defaultValue": { +"$ref": "GoogleAnalyticsAdminV1alphaKeyEventDefaultValue", +"description": "Optional. Defines a default value/currency for a key event." +}, +"deletable": { +"description": "Output only. If set to true, this event can be deleted.", +"readOnly": true, +"type": "boolean" +}, +"eventName": { +"description": "Immutable. The event name for this key event. Examples: 'click', 'purchase'", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleAnalyticsAdminV1alphaKeyEventDefaultValue": { +"description": "Defines a default value/currency for a key event.", +"id": "GoogleAnalyticsAdminV1alphaKeyEventDefaultValue", +"properties": { +"currencyCode": { +"description": "Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.", +"type": "string" +}, +"numericValue": { +"description": "Required. This will be used to populate the \"value\" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails": { "description": "Status information for a link proposal.", "id": "GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails", @@ -7514,6 +7740,24 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1alphaListKeyEventsResponse": { +"description": "Response message for ListKeyEvents RPC.", +"id": "GoogleAnalyticsAdminV1alphaListKeyEventsResponse", +"properties": { +"keyEvents": { +"description": "The requested Key Events", +"items": { +"$ref": "GoogleAnalyticsAdminV1alphaKeyEvent" +}, +"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" +}, "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse": { "description": "Response message for ListMeasurementProtocolSecret RPC", "id": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index 0f53305cef2..3bc31084206 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -626,8 +626,10 @@ }, "resources": { "conversionEvents": { +"deprecated": true, "methods": { "create": { +"deprecated": true, "description": "Creates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", @@ -656,6 +658,7 @@ ] }, "delete": { +"deprecated": true, "description": "Deletes a conversion event in a property.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", @@ -681,6 +684,7 @@ ] }, "get": { +"deprecated": true, "description": "Retrieve a single conversion event.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", @@ -707,6 +711,7 @@ ] }, "list": { +"deprecated": true, "description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", @@ -744,6 +749,7 @@ ] }, "patch": { +"deprecated": true, "description": "Updates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", @@ -1624,11 +1630,165 @@ ] } } +}, +"keyEvents": { +"methods": { +"create": { +"description": "Creates a Key Event.", +"flatPath": "v1beta/properties/{propertiesId}/keyEvents", +"httpMethod": "POST", +"id": "analyticsadmin.properties.keyEvents.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the parent property where this Key Event will be created. Format: properties/123", +"location": "path", +"pattern": "^properties/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1beta/{+parent}/keyEvents", +"request": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEvent" +}, +"response": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +}, +"delete": { +"description": "Deletes a Key Event.", +"flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", +"httpMethod": "DELETE", +"id": "analyticsadmin.properties.keyEvents.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"", +"location": "path", +"pattern": "^properties/[^/]+/keyEvents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +}, +"get": { +"description": "Retrieve a single Key Event.", +"flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", +"httpMethod": "GET", +"id": "analyticsadmin.properties.keyEvents.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"", +"location": "path", +"pattern": "^properties/[^/]+/keyEvents/[^/]+$", +"required": true, +"type": "string" } +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit", +"https://www.googleapis.com/auth/analytics.readonly" +] +}, +"list": { +"description": "Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.", +"flatPath": "v1beta/properties/{propertiesId}/keyEvents", +"httpMethod": "GET", +"id": "analyticsadmin.properties.keyEvents.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent property. Example: 'properties/123'", +"location": "path", +"pattern": "^properties/[^/]+$", +"required": true, +"type": "string" } }, -"revision": "20240329", +"path": "v1beta/{+parent}/keyEvents", +"response": { +"$ref": "GoogleAnalyticsAdminV1betaListKeyEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit", +"https://www.googleapis.com/auth/analytics.readonly" +] +}, +"patch": { +"description": "Updates a Key Event.", +"flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", +"httpMethod": "PATCH", +"id": "analyticsadmin.properties.keyEvents.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}", +"location": "path", +"pattern": "^properties/[^/]+/keyEvents/[^/]+$", +"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": "v1beta/{+name}", +"request": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEvent" +}, +"response": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/analytics.edit" +] +} +} +} +} +} +}, +"revision": "20240405", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -2651,6 +2811,72 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1betaKeyEvent": { +"description": "A key event in a Google Analytics property.", +"id": "GoogleAnalyticsAdminV1betaKeyEvent", +"properties": { +"countingMethod": { +"description": "Required. The method by which Key Events will be counted across multiple events within a session.", +"enum": [ +"COUNTING_METHOD_UNSPECIFIED", +"ONCE_PER_EVENT", +"ONCE_PER_SESSION" +], +"enumDescriptions": [ +"Counting method not specified.", +"Each Event instance is considered a Key Event.", +"An Event instance is considered a Key Event at most once per session per user." +], +"type": "string" +}, +"createTime": { +"description": "Output only. Time when this key event was created in the property.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"custom": { +"description": "Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.", +"readOnly": true, +"type": "boolean" +}, +"defaultValue": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEventDefaultValue", +"description": "Optional. Defines a default value/currency for a key event." +}, +"deletable": { +"description": "Output only. If set to true, this event can be deleted.", +"readOnly": true, +"type": "boolean" +}, +"eventName": { +"description": "Immutable. The event name for this key event. Examples: 'click', 'purchase'", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleAnalyticsAdminV1betaKeyEventDefaultValue": { +"description": "Defines a default value/currency for a key event.", +"id": "GoogleAnalyticsAdminV1betaKeyEventDefaultValue", +"properties": { +"currencyCode": { +"description": "Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.", +"type": "string" +}, +"numericValue": { +"description": "Required. This will be used to populate the \"value\" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleAnalyticsAdminV1betaListAccountSummariesResponse": { "description": "Response message for ListAccountSummaries RPC.", "id": "GoogleAnalyticsAdminV1betaListAccountSummariesResponse", @@ -2795,6 +3021,24 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1betaListKeyEventsResponse": { +"description": "Response message for ListKeyEvents RPC.", +"id": "GoogleAnalyticsAdminV1betaListKeyEventsResponse", +"properties": { +"keyEvents": { +"description": "The requested Key Events", +"items": { +"$ref": "GoogleAnalyticsAdminV1betaKeyEvent" +}, +"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" +}, "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse": { "description": "Response message for ListMeasurementProtocolSecret RPC", "id": "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse", diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index 6e27e154c50..5649c021bba 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -440,7 +440,7 @@ } } }, -"revision": "20240330", +"revision": "20240407", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index b3c20fcbc57..c6f98d6cc93 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -851,7 +851,7 @@ } } }, -"revision": "20240330", +"revision": "20240401", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 17675d1c4cb..e8347c23fee 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2649,7 +2649,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { @@ -4372,7 +4372,7 @@ "Unspecified. Defaults to AUTO_UPDATE_DEFAULT.", "The app is automatically updated with low priority to minimize the impact on the user. The app is updated when the following constraints are met: * The device is not actively used * The device is connected to an unmetered network * The device is charging The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.", "The app is not automatically updated for a maximum of 90 days after the app becomes out of date. 90 days after the app becomes out of date, the latest available version is installed automatically with low priority (see AUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again. The user can still manually update the app from the Play Store at any time.", -"The app is updated as soon as possible. No constraints are applied. The device is notified immediately about a new app update after it is published by the developer." +"The app is updated as soon as possible. No constraints are applied. The device is notified as soon as possible about a new app update after it is published by the developer." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 55f5e55b7f2..150a8c1936b 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1163,7 +1163,7 @@ } } }, -"revision": "20240321", +"revision": "20240402", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1654,7 +1654,7 @@ "Unspecified. Defaults to AUTO_UPDATE_DEFAULT.", "The default update mode.The app is automatically updated with low priority to minimize the impact on the user.The app is updated when all of the following constraints are met: The device is not actively used. The device is connected to an unmetered network. The device is charging. The app to be updated is not running in the foreground.The device is notified about a new update within 24 hours after it is published by the developer, after which the app is updated the next time the constraints above are met.", "The app is not automatically updated for a maximum of 90 days after the app becomes out of date.90 days after the app becomes out of date, the latest available version is installed automatically with low priority (see AUTO_UPDATE_DEFAULT). After the app is updated it is not automatically updated again until 90 days after it becomes out of date again.The user can still manually update the app from the Play Store at any time.", -"The app is updated as soon as possible. No constraints are applied.The device is notified immediately about a new update after it becomes available." +"The app is updated as soon as possible. No constraints are applied.The device is notified as soon as possible about a new update after it becomes available." ], "type": "string" }, @@ -3128,7 +3128,7 @@ false "type": "object" }, "ExtensionConfig": { -"description": "Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command (https://developer.android.com/management/reference/rest/v1/enterprises.devices/issueCommand#CommandType) on extension apps if needed for Android 13 and above.", +"description": "Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 13 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 13 and above.", "id": "ExtensionConfig", "properties": { "notificationReceiver": { @@ -5724,7 +5724,7 @@ false }, "lostPhoneNumber": { "$ref": "UserFacingMessage", -"description": "The phone number displayed to the user when the device is in lost mode." +"description": "The phone number that will be called when the device is in lost mode and the call owner button is tapped." }, "lostStreetAddress": { "$ref": "UserFacingMessage", diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 6428cfecfdb..d51928ca2b6 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4731,7 +4731,7 @@ } } }, -"revision": "20240328", +"revision": "20240408", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -9015,13 +9015,33 @@ false "description": "Defines the scope of subscriptions which a targeting rule can match to target offers to users based on past or current entitlement.", "id": "TargetingRuleScope", "properties": { +"anySubscriptionInApp": { +"$ref": "TargetingRuleScopeAnySubscriptionInApp", +"description": "The scope of the current targeting rule is any subscription in the parent app." +}, "specificSubscriptionInApp": { "description": "The scope of the current targeting rule is the subscription with the specified subscription ID. Must be a subscription within the same parent app.", "type": "string" +}, +"thisSubscription": { +"$ref": "TargetingRuleScopeThisSubscription", +"description": "The scope of the current targeting rule is the subscription in which this offer is defined." } }, "type": "object" }, +"TargetingRuleScopeAnySubscriptionInApp": { +"description": "Represents the targeting rule scope corresponding to any subscription in the parent app.", +"id": "TargetingRuleScopeAnySubscriptionInApp", +"properties": {}, +"type": "object" +}, +"TargetingRuleScopeThisSubscription": { +"description": "Represents the targeting rule scope corresponding to the subscriptions in which this offer is defined.", +"id": "TargetingRuleScopeThisSubscription", +"properties": {}, +"type": "object" +}, "TargetingUpdate": { "description": "Update type for targeting. Note it is always a subset Targeting.", "id": "TargetingUpdate", diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json index 87019b133c8..835b4edf872 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, -"revision": "20240328", +"revision": "20240407", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index 5631e99c44d..57aad5b2a43 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -1307,7 +1307,7 @@ } } }, -"revision": "20240327", +"revision": "20240408", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json index 6125f6ec63a..1a88fb5d136 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json @@ -275,7 +275,7 @@ } } }, -"revision": "20240323", +"revision": "20240407", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1Budget": { diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json index e1f58d28a7a..f79cbc5e8bc 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1beta1.json @@ -269,7 +269,7 @@ } } }, -"revision": "20240323", +"revision": "20240407", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1beta1AllUpdatesRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json index 618101b0bc2..a0f8b5e3f28 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json @@ -742,7 +742,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index 6d876683025..1928e06b654 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index 009751b0c39..1d9c079bf77 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, -"revision": "20240401", +"revision": "20240407", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index d78b23e38d0..88abf1f5cd8 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1710,7 +1710,7 @@ } } }, -"revision": "20240401", +"revision": "20240407", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/books.v1.json b/googleapiclient/discovery_cache/documents/books.v1.json index 66bda850105..30d88880bc3 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2677,7 +2677,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index c36519498dc..9e3e7d7f6a7 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -417,7 +417,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 7a79e3fdc24..82d0134128a 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1088,7 +1088,7 @@ "type": "string" }, "eventTypes": { -"description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. The default is [\"default\", \"focusTime\", \"outOfOffice\"].", +"description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.", "enum": [ "default", "focusTime", @@ -1503,7 +1503,7 @@ "type": "string" }, "eventTypes": { -"description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. The default is [\"default\", \"focusTime\", \"outOfOffice\"].", +"description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.", "enum": [ "default", "focusTime", @@ -1759,7 +1759,7 @@ } } }, -"revision": "20240322", +"revision": "20240328", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 00d6c64e696..eb32020c5b9 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -990,7 +990,7 @@ "spaceEvents": { "methods": { "get": { -"description": "Returns a SpaceEvent. You can request events from up to 28 days before the time of the request. The server will return the most recent version of the resource. For example, if a `google.workspace.chat.message.v1.created` event is requested and the message has since been deleted, the returned event will contain the deleted message resource in the payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).", +"description": "Returns an event from a Google Chat space. The [event payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated `Message` resource in the event payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To get an event, the authenticated user must be a member of the space. For an example, see [Get details about an event from a Google Chat space](https://developers.google.com/workspace/chat/get-space-event).", "flatPath": "v1/spaces/{spacesId}/spaceEvents/{spaceEventsId}", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.get", @@ -999,7 +999,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`", +"description": "Required. The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`", "location": "path", "pattern": "^spaces/[^/]+/spaceEvents/[^/]+$", "required": true, @@ -1022,7 +1022,7 @@ ] }, "list": { -"description": "Lists SpaceEvents in a space that the caller is a member of. You can request events from up to 28 days before the time of the request. The server will return the most recent version of the resources. For example, if a `google.workspace.chat.message.v1.created` event is requested and the message has since been deleted, the returned event will contain the deleted message resource in the payload. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users).", +"description": "Lists events from a Google Chat space. For each event, the [payload](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.oneof_payload) contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns `Membership` resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty `Membership` resource. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To list events, the authenticated user must be a member of the space. For an example, see [List events from a Google Chat space](https://developers.google.com/workspace/chat/list-space-events).", "flatPath": "v1/spaces/{spacesId}/spaceEvents", "httpMethod": "GET", "id": "chat.spaces.spaceEvents.list", @@ -1031,12 +1031,12 @@ ], "parameters": { "filter": { -"description": "Required. A query filter. This method supports filtering by: `event_types`, `start_time`, and `end_time`. `event_types`: You must specify at least one event type in your query. `event_types` supports the has `:` operator. To filter by multiple event types, use the `OR` operator. To see the list of currently supported event types, see google.chat.v1.SpaceEvent.event_type `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the 28 days ago up to end time. `end_time`: Inclusive timestamp up to which space events are listed. Default value is the present. `start_time` and `end_time` accept a timestamp in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339) format and support the equals `=` comparison operator. To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", +"description": "Required. A query filter. You must specify at least one event type (`event_type`) using the has `:` operator. To filter by multiple event types, use the `OR` operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (`google.workspace.chat.reaction.v1.created`), the server also returns batch new reactions events (`google.workspace.chat.reaction.v1.batchCreated`). For a list of supported event types, see the [`SpaceEvents` reference documentation](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents#SpaceEvent.FIELDS.event_type). Optionally, you can also filter by start time (`start_time`) and end time (`end_time`): * `start_time`: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days. * `end_time`: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals `=` operator and format in [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339). To filter by both `start_time` and `end_time`, use the `AND` operator. For example, the following queries are valid: ``` start_time=\"2023-08-23T19:20:33+00:00\" AND end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` start_time=\"2023-08-23T19:20:33+00:00\" AND (event_types:\"google.workspace.chat.space.v1.updated\" OR event_types:\"google.workspace.chat.message.v1.created\") ``` The following queries are invalid: ``` start_time=\"2023-08-23T19:20:33+00:00\" OR end_time=\"2023-08-23T19:21:54+00:00\" ``` ``` event_types:\"google.workspace.chat.space.v1.updated\" AND event_types:\"google.workspace.chat.message.v1.created\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The maximum number of space events returned. The service may return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.", +"description": "Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return an `INVALID_ARGUMENT` error.", "format": "int32", "location": "query", "type": "integer" @@ -1047,7 +1047,7 @@ "type": "string" }, "parent": { -"description": "Required. The resource name of the space from which to list events. Format: `spaces/{space}`.", +"description": "Required. Resource name of the [Google Chat space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) where the events occurred. Format: `spaces/{space}`.", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -1074,7 +1074,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessoryWidget": { @@ -3330,11 +3330,11 @@ "type": "object" }, "MembershipBatchCreatedEventData": { -"description": "Payload for batch new membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchCreated`.", +"description": "Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`", "id": "MembershipBatchCreatedEventData", "properties": { "memberships": { -"description": "A list of created memberships.", +"description": "A list of new memberships.", "items": { "$ref": "MembershipCreatedEventData" }, @@ -3344,7 +3344,7 @@ "type": "object" }, "MembershipBatchDeletedEventData": { -"description": "Payload for batch deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchDeleted`.", +"description": "Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`", "id": "MembershipBatchDeletedEventData", "properties": { "memberships": { @@ -3358,7 +3358,7 @@ "type": "object" }, "MembershipBatchUpdatedEventData": { -"description": "Payload for batch updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchUpdated`.", +"description": "Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`", "id": "MembershipBatchUpdatedEventData", "properties": { "memberships": { @@ -3372,34 +3372,34 @@ "type": "object" }, "MembershipCreatedEventData": { -"description": "Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`.", +"description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`.", "id": "MembershipCreatedEventData", "properties": { "membership": { "$ref": "Membership", -"description": "The most recent version of membership." +"description": "The new membership." } }, "type": "object" }, "MembershipDeletedEventData": { -"description": "Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`.", +"description": "Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`", "id": "MembershipDeletedEventData", "properties": { "membership": { "$ref": "Membership", -"description": "The deleted membership. Only `name` and `state` are populated." +"description": "The deleted membership. Only the `name` and `state` fields are populated." } }, "type": "object" }, "MembershipUpdatedEventData": { -"description": "Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`.", +"description": "Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`", "id": "MembershipUpdatedEventData", "properties": { "membership": { "$ref": "Membership", -"description": "The most recent version of membership." +"description": "The updated membership." } }, "type": "object" @@ -3554,11 +3554,11 @@ "type": "object" }, "MessageBatchCreatedEventData": { -"description": "Payload for batch new message events where the `EventType` field is `google.workspace.chat.message.v1.batchCreated`.", +"description": "Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`", "id": "MessageBatchCreatedEventData", "properties": { "messages": { -"description": "A list of created messages.", +"description": "A list of new messages.", "items": { "$ref": "MessageCreatedEventData" }, @@ -3568,7 +3568,7 @@ "type": "object" }, "MessageBatchDeletedEventData": { -"description": "Payload for batch deleted message events where the `EventType` field is `google.workspace.chat.message.v1.batchDeleted`.", +"description": "Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`", "id": "MessageBatchDeletedEventData", "properties": { "messages": { @@ -3582,7 +3582,7 @@ "type": "object" }, "MessageBatchUpdatedEventData": { -"description": "Payload for batch updated message events where the `EventType` field is `google.workspace.chat.message.v1.batchUpdated`.", +"description": "Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`", "id": "MessageBatchUpdatedEventData", "properties": { "messages": { @@ -3596,34 +3596,34 @@ "type": "object" }, "MessageCreatedEventData": { -"description": "Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`.", +"description": "Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`", "id": "MessageCreatedEventData", "properties": { "message": { "$ref": "Message", -"description": "The most recent version of the message." +"description": "The new message." } }, "type": "object" }, "MessageDeletedEventData": { -"description": "Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`.", +"description": "Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`", "id": "MessageDeletedEventData", "properties": { "message": { "$ref": "Message", -"description": "The deleted message. Only `name`, `createTime`, `deleteTime`, and `deletionMetadata` are populated." +"description": "The deleted message. Only the `name`, `createTime`, `deleteTime`, and `deletionMetadata` fields are populated." } }, "type": "object" }, "MessageUpdatedEventData": { -"description": "Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`.", +"description": "Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`", "id": "MessageUpdatedEventData", "properties": { "message": { "$ref": "Message", -"description": "The most recent version of the message." +"description": "The updated message." } }, "type": "object" @@ -3693,11 +3693,11 @@ "type": "object" }, "ReactionBatchCreatedEventData": { -"description": "Payload for batch new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchCreated`.", +"description": "Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`", "id": "ReactionBatchCreatedEventData", "properties": { "reactions": { -"description": "A list of created reactions.", +"description": "A list of new reactions.", "items": { "$ref": "ReactionCreatedEventData" }, @@ -3707,7 +3707,7 @@ "type": "object" }, "ReactionBatchDeletedEventData": { -"description": "Payload for batch deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchDeleted`.", +"description": "Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`", "id": "ReactionBatchDeletedEventData", "properties": { "reactions": { @@ -3721,18 +3721,18 @@ "type": "object" }, "ReactionCreatedEventData": { -"description": "Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`.", +"description": "Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`", "id": "ReactionCreatedEventData", "properties": { "reaction": { "$ref": "Reaction", -"description": "The created reaction." +"description": "The new reaction." } }, "type": "object" }, "ReactionDeletedEventData": { -"description": "Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`.", +"description": "Event payload for a deleted reaction. Type: `google.workspace.chat.reaction.v1.deleted`", "id": "ReactionDeletedEventData", "properties": { "reaction": { @@ -3983,7 +3983,7 @@ "type": "object" }, "SpaceBatchUpdatedEventData": { -"description": "Payload for batch updated space events where the `EventType` field is `google.workspace.chat.space.v1.batchUpdated`.", +"description": "Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`", "id": "SpaceBatchUpdatedEventData", "properties": { "spaces": { @@ -4023,104 +4023,104 @@ "type": "object" }, "SpaceEvent": { -"description": "An event that happens in a specific space.", +"description": "An event that represents a change or activity in a Google Chat space. To learn more, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", "id": "SpaceEvent", "properties": { "eventTime": { -"description": "Time of the event.", +"description": "Time when the event occurred.", "format": "google-datetime", "type": "string" }, "eventType": { -"description": "Type of the space event. The following event types are supported: * New membership: `google.workspace.chat.membership.v1.created` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Updated membership: `google.workspace.chat.membership.v1.updated` * New message: `google.workspace.chat.message.v1.created` * Deleted message: `google.workspace.chat.message.v1.deleted` * Updated message: `google.workspace.chat.message.v1.updated` * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Updated space: `google.workspace.chat.space.v1.updated` Note that requesting or subscribing to the preceding event types automatically sets up the subscription or response to also return batched versions of the event type. For example, if you subscribe to `google.workspace.chat.membership.v1.created`, you also receive events for `google.workspace.chat.membership.v1.batchCreated`. For more details see https://developers.google.com/workspace/events/guides/events-chat#output_only_event_types.", +"description": "Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For `spaceEvents.list()` requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version. Supported event types for [messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages): * New message: `google.workspace.chat.message.v1.created` * Updated message: `google.workspace.chat.message.v1.updated` * Deleted message: `google.workspace.chat.message.v1.deleted` * Multiple new messages: `google.workspace.chat.message.v1.batchCreated` * Multiple updated messages: `google.workspace.chat.message.v1.batchUpdated` * Multiple deleted messages: `google.workspace.chat.message.v1.batchDeleted` Supported event types for [memberships](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members): * New membership: `google.workspace.chat.membership.v1.created` * Updated membership: `google.workspace.chat.membership.v1.updated` * Deleted membership: `google.workspace.chat.membership.v1.deleted` * Multiple new memberships: `google.workspace.chat.membership.v1.batchCreated` * Multiple updated memberships: `google.workspace.chat.membership.v1.batchUpdated` * Multiple deleted memberships: `google.workspace.chat.membership.v1.batchDeleted` Supported event types for [reactions](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.reactions): * New reaction: `google.workspace.chat.reaction.v1.created` * Deleted reaction: `google.workspace.chat.reaction.v1.deleted` * Multiple new reactions: `google.workspace.chat.reaction.v1.batchCreated` * Multiple deleted reactions: `google.workspace.chat.reaction.v1.batchDeleted` Supported event types about the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces): * Updated space: `google.workspace.chat.space.v1.updated` * Multiple space updates: `google.workspace.chat.space.v1.batchUpdated`", "type": "string" }, "membershipBatchCreatedEventData": { "$ref": "MembershipBatchCreatedEventData", -"description": "Payload for batch new membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchCreated`." +"description": "Event payload for multiple new memberships. Event type: `google.workspace.chat.membership.v1.batchCreated`" }, "membershipBatchDeletedEventData": { "$ref": "MembershipBatchDeletedEventData", -"description": "Payload for batch deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchDeleted`." +"description": "Event payload for multiple deleted memberships. Event type: `google.workspace.chat.membership.v1.batchDeleted`" }, "membershipBatchUpdatedEventData": { "$ref": "MembershipBatchUpdatedEventData", -"description": "Payload for batch updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.batchUpdated`." +"description": "Event payload for multiple updated memberships. Event type: `google.workspace.chat.membership.v1.batchUpdated`" }, "membershipCreatedEventData": { "$ref": "MembershipCreatedEventData", -"description": "Payload for new membership events where the `EventType` field is `google.workspace.chat.membership.v1.created`." +"description": "Event payload for a new membership. Event type: `google.workspace.chat.membership.v1.created`" }, "membershipDeletedEventData": { "$ref": "MembershipDeletedEventData", -"description": "Payload for deleted membership events where the `EventType` field is `google.workspace.chat.membership.v1.deleted`." +"description": "Event payload for a deleted membership. Event type: `google.workspace.chat.membership.v1.deleted`" }, "membershipUpdatedEventData": { "$ref": "MembershipUpdatedEventData", -"description": "Payload for updated membership events where the `EventType` field is `google.workspace.chat.membership.v1.updated`." +"description": "Event payload for an updated membership. Event type: `google.workspace.chat.membership.v1.updated`" }, "messageBatchCreatedEventData": { "$ref": "MessageBatchCreatedEventData", -"description": "Payload for batch new message events where the `EventType` field is `google.workspace.chat.message.v1.batchCreated`." +"description": "Event payload for multiple new messages. Event type: `google.workspace.chat.message.v1.batchCreated`" }, "messageBatchDeletedEventData": { "$ref": "MessageBatchDeletedEventData", -"description": "Payload for batch deleted message events where the `EventType` field is `google.workspace.chat.message.v1.batchDeleted`." +"description": "Event payload for multiple deleted messages. Event type: `google.workspace.chat.message.v1.batchDeleted`" }, "messageBatchUpdatedEventData": { "$ref": "MessageBatchUpdatedEventData", -"description": "Payload for batch updated message events where the `EventType` field is `google.workspace.chat.message.v1.batchUpdated`." +"description": "Event payload for multiple updated messages. Event type: `google.workspace.chat.message.v1.batchUpdated`" }, "messageCreatedEventData": { "$ref": "MessageCreatedEventData", -"description": "Payload for new message events where the `EventType` field is `google.workspace.chat.message.v1.created`." +"description": "Event payload for a new message. Event type: `google.workspace.chat.message.v1.created`" }, "messageDeletedEventData": { "$ref": "MessageDeletedEventData", -"description": "Payload for deleted message events where the `EventType` field is `google.workspace.chat.message.v1.deleted`." +"description": "Event payload for a deleted message. Event type: `google.workspace.chat.message.v1.deleted`" }, "messageUpdatedEventData": { "$ref": "MessageUpdatedEventData", -"description": "Payload for updated message events where the `EventType` field is `google.workspace.chat.message.v1.updated`." +"description": "Event payload for an updated message. Event type: `google.workspace.chat.message.v1.updated`" }, "name": { -"description": "The resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`", +"description": "Resource name of the space event. Format: `spaces/{space}/spaceEvents/{spaceEvent}`", "type": "string" }, "reactionBatchCreatedEventData": { "$ref": "ReactionBatchCreatedEventData", -"description": "Payload for batch new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchCreated`." +"description": "Event payload for multiple new reactions. Event type: `google.workspace.chat.reaction.v1.batchCreated`" }, "reactionBatchDeletedEventData": { "$ref": "ReactionBatchDeletedEventData", -"description": "Payload for batch deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.batchDeleted`." +"description": "Event payload for multiple deleted reactions. Event type: `google.workspace.chat.reaction.v1.batchDeleted`" }, "reactionCreatedEventData": { "$ref": "ReactionCreatedEventData", -"description": "Payload for new reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.created`." +"description": "Event payload for a new reaction. Event type: `google.workspace.chat.reaction.v1.created`" }, "reactionDeletedEventData": { "$ref": "ReactionDeletedEventData", -"description": "Payload for deleted reaction events where the `EventType` field is `google.workspace.chat.reaction.v1.deleted`." +"description": "Event payload for a deleted reaction. Event type: `google.workspace.chat.reaction.v1.deleted`" }, "spaceBatchUpdatedEventData": { "$ref": "SpaceBatchUpdatedEventData", -"description": "Payload for batch updated space events where the `EventType` field is `google.workspace.chat.space.v1.batchUpdated`." +"description": "Event payload for multiple updates to a space. Event type: `google.workspace.chat.space.v1.batchUpdated`" }, "spaceUpdatedEventData": { "$ref": "SpaceUpdatedEventData", -"description": "Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`." +"description": "Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated`" } }, "type": "object" }, "SpaceUpdatedEventData": { -"description": "Payload for updated space events where the `EventType` field is `google.workspace.chat.space.v1.updated`.", +"description": "Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated`", "id": "SpaceUpdatedEventData", "properties": { "space": { "$ref": "Space", -"description": "The recent version of the space." +"description": "The updated space." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index 1f8b6995360..3f7332cfc7c 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -414,7 +414,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index cee0f9a2f24..efcbbffe41b 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -1172,7 +1172,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index 8cd06d20b82..5cfcdd68ce2 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -557,7 +557,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index 725ede34eb3..d44c9a68712 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -131,7 +131,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/civicinfo.v2.json b/googleapiclient/discovery_cache/documents/civicinfo.v2.json index 73962bea81c..9d3667265f6 100644 --- a/googleapiclient/discovery_cache/documents/civicinfo.v2.json +++ b/googleapiclient/discovery_cache/documents/civicinfo.v2.json @@ -365,7 +365,7 @@ } } }, -"revision": "20240325", +"revision": "20240402", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index 6d4c415c46e..66b17feb6a7 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -2400,7 +2400,7 @@ } } }, -"revision": "20240325", +"revision": "20240401", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "Announcement": { diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index 31a79988266..d1a52960c02 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -2183,7 +2183,7 @@ } } }, -"revision": "20240331", +"revision": "20240403", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 9a1d36005fd..67a6d371d86 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1990,7 +1990,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index d10a184dcdf..fae1955a4ee 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2015,7 +2015,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json index f207ee3cf42..bf019aac567 100644 --- a/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudprofiler.v2.json @@ -254,7 +254,7 @@ } } }, -"revision": "20240325", +"revision": "20240331", "rootUrl": "https://cloudprofiler.googleapis.com/", "schemas": { "CreateProfileRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index 93b56c1e672..b390e2b1817 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240331", +"revision": "20240403", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -778,31 +778,32 @@ "type": "object" }, "Comment": { -"description": "Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.", +"description": "A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.", "id": "Comment", "properties": { "body": { -"description": "The full comment body. Maximum of 12800 characters. This can contain rich text syntax.", +"description": "The full comment body. Maximum of 12800 characters.", "type": "string" }, "createTime": { -"description": "Output only. The time when this comment was created.", +"description": "Output only. The time when the comment was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "creator": { "$ref": "Actor", -"description": "Output only. The user or Google Support agent created this comment.", +"description": "Output only. The user or Google Support agent who created the comment.", "readOnly": true }, "name": { -"description": "Output only. The resource name for the comment.", +"description": "Output only. Identifier. The resource name of the comment.", "readOnly": true, "type": "string" }, "plainTextBody": { -"description": "Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.", +"deprecated": true, +"description": "Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index a5482ee3422..53259bb9099 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -548,7 +548,7 @@ } } }, -"revision": "20240331", +"revision": "20240403", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -794,31 +794,32 @@ "type": "object" }, "Comment": { -"description": "Case comments are the main way Google Support communicates with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.", +"description": "A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.", "id": "Comment", "properties": { "body": { -"description": "The full comment body. Maximum of 12800 characters. This can contain rich text syntax.", +"description": "The full comment body. Maximum of 12800 characters.", "type": "string" }, "createTime": { -"description": "Output only. The time when this comment was created.", +"description": "Output only. The time when the comment was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "creator": { "$ref": "Actor", -"description": "Output only. The user or Google Support agent created this comment.", +"description": "Output only. The user or Google Support agent who created the comment.", "readOnly": true }, "name": { -"description": "Output only. The resource name for the comment.", +"description": "Output only. Identifier. The resource name of the comment.", "readOnly": true, "type": "string" }, "plainTextBody": { -"description": "Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped.", +"deprecated": true, +"description": "Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json index 32b5d2309d0..74647031c29 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v1.json @@ -257,7 +257,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json index 4df31b44ec7..0fdddf76e6d 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2.json @@ -181,7 +181,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json index 6f8180d90e4..10be1b9c799 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json @@ -273,7 +273,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 049836c7930..3fa35eef4af 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -44323,7 +44323,7 @@ } } }, -"revision": "20240324", +"revision": "20240326", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -63576,6 +63576,10 @@ false "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", "type": "boolean" }, +"applicationAwareInterconnect": { +"$ref": "InterconnectApplicationAwareInterconnect", +"description": "Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router." +}, "availableFeatures": { "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { @@ -63774,6 +63778,78 @@ false }, "type": "object" }, +"InterconnectApplicationAwareInterconnect": { +"description": "Configuration information for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router.", +"id": "InterconnectApplicationAwareInterconnect", +"properties": { +"bandwidthPercentagePolicy": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" +}, +"enabled": { +"description": "Enable or disable the AAI feature on this interconnect.", +"type": "boolean" +}, +"profileDescription": { +"description": "A description for the AAI profile on this interconnect.", +"type": "string" +}, +"strictPriorityPolicy": { +"$ref": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy" +} +}, +"type": "object" +}, +"InterconnectApplicationAwareInterconnectBandwidthPercentage": { +"description": "Specify bandwidth percentages (0-100) for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. It is valid to specify percentages for some classes and not for others. The others will be implicitly marked as 0.", +"id": "InterconnectApplicationAwareInterconnectBandwidthPercentage", +"properties": { +"percentage": { +"description": "Bandwidth percentage for a specific traffic class.", +"format": "uint32", +"type": "integer" +}, +"trafficClass": { +"description": "TrafficClass whose bandwidth percentage is being specified.", +"enum": [ +"TC1", +"TC2", +"TC3", +"TC4", +"TC5", +"TC6" +], +"enumDescriptions": [ +"Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.", +"Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.", +"Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.", +"Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.", +"Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.", +"Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx." +], +"type": "string" +} +}, +"type": "object" +}, +"InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy": { +"id": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy", +"properties": { +"bandwidthPercentages": { +"description": "Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent.", +"items": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage" +}, +"type": "array" +} +}, +"type": "object" +}, +"InterconnectApplicationAwareInterconnectStrictPriorityPolicy": { +"description": "Specify configuration for StrictPriorityPolicy.", +"id": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy", +"properties": {}, +"type": "object" +}, "InterconnectAttachment": { "description": "Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments.", "id": "InterconnectAttachment", @@ -75327,15 +75403,15 @@ false }, "defaultRouteAction": { "$ref": "HttpRouteAction", -"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." +"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." }, "defaultService": { -"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", +"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", "type": "string" }, "defaultUrlRedirect": { "$ref": "HttpRedirectAction", -"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy." +"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy." }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", @@ -79752,6 +79828,11 @@ false "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": { @@ -79765,12 +79846,16 @@ false "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", +"SYSTEM_GLOBAL", +"SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ "", "", "", +"", +"", "" ], "type": "string" @@ -96186,7 +96271,7 @@ false "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { -"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", +"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index bacbbb15475..fca77123d93 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -41579,7 +41579,7 @@ } } }, -"revision": "20240324", +"revision": "20240326", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -69821,15 +69821,15 @@ false }, "defaultRouteAction": { "$ref": "HttpRouteAction", -"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." +"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." }, "defaultService": { -"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", +"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", "type": "string" }, "defaultUrlRedirect": { "$ref": "HttpRedirectAction", -"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy." +"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy." }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", @@ -88151,7 +88151,7 @@ false "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { -"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", +"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 731e6efbaf1..e110b2c34b8 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -37371,7 +37371,7 @@ } } }, -"revision": "20240324", +"revision": "20240326", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -63875,15 +63875,15 @@ false "properties": { "defaultRouteAction": { "$ref": "HttpRouteAction", -"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." +"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction." }, "defaultService": { -"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", +"description": "The full or partial URL to the BackendService resource. This URL is used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - global/backendServices/backendService If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use ", "type": "string" }, "defaultUrlRedirect": { "$ref": "HttpRedirectAction", -"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to a target gRPC proxy." +"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, then set either defaultService or defaultRouteAction. Don't set both. Not supported when the URL map is bound to a target gRPC proxy." }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", @@ -80952,7 +80952,7 @@ false "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { -"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", +"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 85fe8d639e4..85e4fa862b8 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -1473,7 +1473,7 @@ } } }, -"revision": "20240324", +"revision": "20240402", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index e57d0564744..df7691784fa 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -2838,6 +2838,39 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] +}, +"triggeraction": { +"description": "Start an action. The action can be requested by merchants in third-party application. Before merchants can request the action, the third-party application needs to show them action specific content and display a user input form. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.", +"flatPath": "{merchantId}/merchantsupport/triggeraction", +"httpMethod": "POST", +"id": "content.merchantsupport.triggeraction", +"parameterOrder": [ +"merchantId" +], +"parameters": { +"languageCode": { +"description": "Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.", +"location": "query", +"type": "string" +}, +"merchantId": { +"description": "Required. The ID of the merchant's account.", +"format": "int64", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "{merchantId}/merchantsupport/triggeraction", +"request": { +"$ref": "TriggerActionPayload" +}, +"response": { +"$ref": "TriggerActionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] } } }, @@ -6186,7 +6219,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -7485,6 +7518,10 @@ false "$ref": "BuiltInSimpleAction", "description": "Action implemented and performed in (your) third-party application. The application should point the merchant to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available." }, +"builtinUserInputAction": { +"$ref": "BuiltInUserInputAction", +"description": "Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant as specified for given action. They can trigger the action only when they provided all required inputs." +}, "buttonLabel": { "description": "Label of the action button.", "type": "string" @@ -7507,6 +7544,62 @@ false }, "type": "object" }, +"ActionFlow": { +"description": "Flow that can be selected for an action. When merchant selects a flow, application should open a dialog with more information and input form.", +"id": "ActionFlow", +"properties": { +"dialogButtonLabel": { +"description": "Label for the button to trigger the action from the action dialog. For example: \"Request review\"", +"type": "string" +}, +"dialogCallout": { +"$ref": "Callout", +"description": "Important message to be highlighted in the request dialog. For example: \"You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review.\"" +}, +"dialogMessage": { +"$ref": "TextWithTooltip", +"description": "Message displayed in the request dialog. For example: \"Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review\". There may be an more information to be shown in a tooltip." +}, +"dialogTitle": { +"description": "Title of the request dialog. For example: \"Before you request a review\"", +"type": "string" +}, +"id": { +"description": "Not for display but need to be sent back for the selected action flow.", +"type": "string" +}, +"inputs": { +"description": "A list of input fields.", +"items": { +"$ref": "InputField" +}, +"type": "array" +}, +"label": { +"description": "Text value describing the intent for the action flow. It can be used as an input label if merchant needs to pick one of multiple flows. For example: \"I disagree with the issue\"", +"type": "string" +} +}, +"type": "object" +}, +"ActionInput": { +"description": "Input provided by the merchant.", +"id": "ActionInput", +"properties": { +"actionFlowId": { +"description": "Required. Id of the selected action flow.", +"type": "string" +}, +"inputValues": { +"description": "Required. Values for input fields.", +"items": { +"$ref": "InputValue" +}, +"type": "array" +} +}, +"type": "object" +}, "ActionReason": { "description": "A single reason why the action is not available.", "id": "ActionReason", @@ -7855,6 +7948,24 @@ false }, "type": "object" }, +"BuiltInUserInputAction": { +"description": "Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the [triggeraction method](https://developers.google.com/shopping-content/reference/rest/v2.1/merchantsupport/triggeraction).", +"id": "BuiltInUserInputAction", +"properties": { +"actionContext": { +"description": "Internal details. Not for display but need to be sent back when triggering the action.", +"type": "string" +}, +"flows": { +"description": "Actions may provide multiple different flows. Merchant selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.", +"items": { +"$ref": "ActionFlow" +}, +"type": "array" +} +}, +"type": "object" +}, "BusinessDayConfig": { "id": "BusinessDayConfig", "properties": { @@ -7966,6 +8077,33 @@ false }, "type": "object" }, +"Callout": { +"description": "An important message that should be highlighted. Usually displayed as a banner.", +"id": "Callout", +"properties": { +"fullMessage": { +"$ref": "TextWithTooltip", +"description": "A full message that needs to be shown to the merchant." +}, +"styleHint": { +"description": "Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to merchants.", +"enum": [ +"CALLOUT_STYLE_HINT_UNSPECIFIED", +"ERROR", +"WARNING", +"INFO" +], +"enumDescriptions": [ +"Default value. Will never be provided by the API.", +"The most important type of information highlighting problems, like an unsuccessful outcome of previously requested actions.", +"Information warning about pending problems, risks or deadlines.", +"Default severity for important information like pending status of previously requested action or cooldown for re-review." +], +"type": "string" +} +}, +"type": "object" +}, "CaptureOrderRequest": { "description": "Request message for the CaptureOrder method.", "id": "CaptureOrderRequest", @@ -9677,6 +9815,165 @@ false }, "type": "object" }, +"InputField": { +"description": "Input field that needs to be available to the merchant. If the field is marked as required, then a value needs to be provided for a successful processing of the request.", +"id": "InputField", +"properties": { +"checkboxInput": { +"$ref": "InputFieldCheckboxInput", +"description": "Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox)." +}, +"choiceInput": { +"$ref": "InputFieldChoiceInput", +"description": "Input field to select one of the offered choices. Corresponds to the [html input type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio)." +}, +"id": { +"description": "Not for display but need to be sent back for the given input field.", +"type": "string" +}, +"label": { +"$ref": "TextWithTooltip", +"description": "Input field label. There may be more information to be shown in a tooltip." +}, +"required": { +"description": "Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.", +"type": "boolean" +}, +"textInput": { +"$ref": "InputFieldTextInput", +"description": "Input field to provide text information. Corresponds to the [html input type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea)." +} +}, +"type": "object" +}, +"InputFieldCheckboxInput": { +"description": "Checkbox input allows merchants to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). If merchant checks the box, the input value for the field is `true`, otherwise it is `false`. This type of input is often used as a confirmation that the merchant completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the merchant checks the box.", +"id": "InputFieldCheckboxInput", +"properties": {}, +"type": "object" +}, +"InputFieldChoiceInput": { +"description": "Choice input allows merchants to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the merchant. For example, additional input field can be hidden or disabled until the merchant selects the specific choice.", +"id": "InputFieldChoiceInput", +"properties": { +"options": { +"description": "A list of choices. Only one option can be selected.", +"items": { +"$ref": "InputFieldChoiceInputChoiceInputOption" +}, +"type": "array" +} +}, +"type": "object" +}, +"InputFieldChoiceInputChoiceInputOption": { +"description": "A choice that merchant can select.", +"id": "InputFieldChoiceInputChoiceInputOption", +"properties": { +"additionalInput": { +"$ref": "InputField", +"description": "Input that should be displayed when this option is selected. The additional input will not contain a `ChoiceInput`." +}, +"id": { +"description": "Not for display but need to be sent back for the selected choice option.", +"type": "string" +}, +"label": { +"$ref": "TextWithTooltip", +"description": "Short description of the choice option. There may be more information to be shown as a tooltip." +} +}, +"type": "object" +}, +"InputFieldTextInput": { +"description": "Text input allows merchants to provide a text value.", +"id": "InputFieldTextInput", +"properties": { +"additionalInfo": { +"$ref": "TextWithTooltip", +"description": "Additional info regarding the field to be displayed to merchant. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip." +}, +"ariaLabel": { +"description": "Text to be used as the [aria label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the input.", +"type": "string" +}, +"formatInfo": { +"description": "Information about the required format. If present, it should be shown close to the input field to help merchants to provide a correct value. For example: \"VAT numbers should be in a format similar to SK9999999999\"", +"type": "string" +}, +"type": { +"description": "Type of the text input", +"enum": [ +"TEXT_INPUT_TYPE_UNSPECIFIED", +"GENERIC_SHORT_TEXT", +"GENERIC_LONG_TEXT" +], +"enumDescriptions": [ +"Default value. Will never be provided by the API.", +"Used when a short text is expected. The field can be rendered as a [text field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).", +"Used when a longer text is expected. The field should be rendered as a [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea)." +], +"type": "string" +} +}, +"type": "object" +}, +"InputValue": { +"description": "Input provided by the merchant for input field.", +"id": "InputValue", +"properties": { +"checkboxInputValue": { +"$ref": "InputValueCheckboxInputValue", +"description": "Value for checkbox input field." +}, +"choiceInputValue": { +"$ref": "InputValueChoiceInputValue", +"description": "Value for choice input field." +}, +"inputFieldId": { +"description": "Required. Id of the corresponding input field.", +"type": "string" +}, +"textInputValue": { +"$ref": "InputValueTextInputValue", +"description": "Value for text input field." +} +}, +"type": "object" +}, +"InputValueCheckboxInputValue": { +"description": "Value for checkbox input field.", +"id": "InputValueCheckboxInputValue", +"properties": { +"value": { +"description": "Required. True if the merchant checked the box field. False otherwise.", +"type": "boolean" +} +}, +"type": "object" +}, +"InputValueChoiceInputValue": { +"description": "Value for choice input field.", +"id": "InputValueChoiceInputValue", +"properties": { +"choiceInputOptionId": { +"description": "Required. Id of the option that was selected by the merchant.", +"type": "string" +} +}, +"type": "object" +}, +"InputValueTextInputValue": { +"description": "Value for text input field.", +"id": "InputValueTextInputValue", +"properties": { +"value": { +"description": "Required. Text provided by the merchant.", +"type": "string" +} +}, +"type": "object" +}, "InsertCheckoutSettingsRequest": { "description": "Request message for the `InsertCheckoutSettings` method.", "id": "InsertCheckoutSettingsRequest", @@ -14140,6 +14437,14 @@ false "description": "The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", "type": "string" }, +"structuredDescription": { +"$ref": "ProductStructuredDescription", +"description": "Structured description, for algorithmically (AI)-generated descriptions." +}, +"structuredTitle": { +"$ref": "ProductStructuredTitle", +"description": "Structured title, for algorithmically (AI)-generated titles." +}, "subscriptionCost": { "$ref": "ProductSubscriptionCost", "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract." @@ -14672,6 +14977,36 @@ false }, "type": "object" }, +"ProductStructuredDescription": { +"description": "Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information.", +"id": "ProductStructuredDescription", +"properties": { +"content": { +"description": "Required. The description text. Maximum length is 5000 characters.", +"type": "string" +}, +"digitalSourceType": { +"description": "Optional. The digital source type. Acceptable values are: - \"`trained_algorithmic_media`\" - \"`default`\" ", +"type": "string" +} +}, +"type": "object" +}, +"ProductStructuredTitle": { +"description": "Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information.", +"id": "ProductStructuredTitle", +"properties": { +"content": { +"description": "Required. The title text. Maximum length is 150 characters.", +"type": "string" +}, +"digitalSourceType": { +"description": "Optional. The digital source type. Acceptable values are: - \"`trained_algorithmic_media`\" - \"`default`\" ", +"type": "string" +} +}, +"type": "object" +}, "ProductSubscriptionCost": { "id": "ProductSubscriptionCost", "properties": { @@ -16062,6 +16397,20 @@ false "Returns the detail of the issue as a pre-rendered HTML text." ], "type": "string" +}, +"userInputActionOption": { +"description": "Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action.", +"enum": [ +"USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED", +"REDIRECT_TO_MERCHANT_CENTER", +"BUILT_IN_USER_INPUT_ACTIONS" +], +"enumDescriptions": [ +"Default value. Will never be provided by the API.", +"Actions that require user input are represented only as links that points merchant to Merchant Center where they can request the action. Provides easier to implement alternative to `BUILT_IN_USER_INPUT_ACTIONS`.", +"Returns content and input form definition for each complex action. Your application needs to display this content and input form to the merchant before they can request processing of the action. To start the action, your application needs to call the `triggeraction` method." +], +"type": "string" } }, "type": "object" @@ -16099,6 +16448,20 @@ false "Returns the detail of the issue as a pre-rendered HTML text." ], "type": "string" +}, +"userInputActionOption": { +"description": "Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action.", +"enum": [ +"USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED", +"REDIRECT_TO_MERCHANT_CENTER", +"BUILT_IN_USER_INPUT_ACTIONS" +], +"enumDescriptions": [ +"Default value. Will never be provided by the API.", +"Actions that require user input are represented only as links that points merchant to Merchant Center where they can request the action. Provides easier to implement alternative to `BUILT_IN_USER_INPUT_ACTIONS`.", +"Returns content and input form definition for each complex action. Your application needs to display this content and input form to the merchant before they can request processing of the action. To start the action, your application needs to call the `triggeraction` method." +], +"type": "string" } }, "type": "object" @@ -18039,6 +18402,35 @@ false }, "type": "object" }, +"TextWithTooltip": { +"description": "Block of text that may contain a tooltip with more information.", +"id": "TextWithTooltip", +"properties": { +"simpleTooltipValue": { +"description": "Value of the tooltip as a simple text.", +"type": "string" +}, +"simpleValue": { +"description": "Value of the message as a simple text.", +"type": "string" +}, +"tooltipIconStyle": { +"description": "The suggested type of an icon for tooltip, if a tooltip is present.", +"enum": [ +"TOOLTIP_ICON_STYLE_UNSPECIFIED", +"INFO", +"QUESTION" +], +"enumDescriptions": [ +"Default value. Will never be provided by the API.", +"Used when the tooltip adds additional information to the context, the 'i' can be used as an icon.", +"Used when the tooltip shows helpful information, the '?' can be used as an icon." +], +"type": "string" +} +}, +"type": "object" +}, "TimePeriod": { "description": "A message that represents a time period.", "id": "TimePeriod", @@ -18174,6 +18566,32 @@ false }, "type": "object" }, +"TriggerActionPayload": { +"description": "The payload for the triggered action.", +"id": "TriggerActionPayload", +"properties": { +"actionContext": { +"description": "Required. The context from the selected action. The value is obtained from rendered issues and needs to be sent back to identify the action that is being triggered.", +"type": "string" +}, +"actionInput": { +"$ref": "ActionInput", +"description": "Required. Input provided by the merchant." +} +}, +"type": "object" +}, +"TriggerActionResponse": { +"description": "Response informing about the started action.", +"id": "TriggerActionResponse", +"properties": { +"message": { +"description": "The message for merchant.", +"type": "string" +} +}, +"type": "object" +}, "UndeleteConversionSourceRequest": { "description": "Request message for the UndeleteConversionSource method.", "id": "UndeleteConversionSourceRequest", diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index e245a676ed3..1d2a89dd868 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -690,7 +690,7 @@ false } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 3c74cd4855f..493e9181751 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -798,7 +798,7 @@ } } }, -"revision": "20240315", +"revision": "20240327", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1.json b/googleapiclient/discovery_cache/documents/dataportability.v1.json index 137dd365b49..8dfe055d85f 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1.json @@ -59,9 +59,6 @@ "https://www.googleapis.com/auth/dataportability.maps.photos_videos": { "description": "Move a copy of the photos and videos you posted on Maps." }, -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback": { -"description": "Move a copy of feedback you gave after completing trips using Maps directions." -}, "https://www.googleapis.com/auth/dataportability.maps.questions_answers": { "description": "Move a copy of the questions and answers you posted on Maps." }, @@ -340,7 +337,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -432,7 +428,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -518,7 +513,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -604,7 +598,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -655,7 +648,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json index 45e6a35fa5c..eb32e3ba288 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json @@ -59,9 +59,6 @@ "https://www.googleapis.com/auth/dataportability.maps.photos_videos": { "description": "Move a copy of the photos and videos you posted on Maps." }, -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback": { -"description": "Move a copy of feedback you gave after completing trips using Maps directions." -}, "https://www.googleapis.com/auth/dataportability.maps.questions_answers": { "description": "Move a copy of the questions and answers you posted on Maps." }, @@ -340,7 +337,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -432,7 +428,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -518,7 +513,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -604,7 +598,6 @@ "https://www.googleapis.com/auth/dataportability.maps.factual_contributions", "https://www.googleapis.com/auth/dataportability.maps.offering_contributions", "https://www.googleapis.com/auth/dataportability.maps.photos_videos", -"https://www.googleapis.com/auth/dataportability.maps.post_trip_feedback", "https://www.googleapis.com/auth/dataportability.maps.questions_answers", "https://www.googleapis.com/auth/dataportability.maps.reviews", "https://www.googleapis.com/auth/dataportability.maps.starred_places", @@ -655,7 +648,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index d2fc6a9eaa7..137e727bdc3 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -3072,7 +3072,7 @@ } } }, -"revision": "20240327", +"revision": "20240403", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 77cda556320..b7badd31123 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1588,7 +1588,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index 7c8359f088a..4d0c3c28475 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -988,7 +988,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index e63b4888f95..9f6daee3099 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1552,7 +1552,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 4fb40270d43..9e25f9f3366 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -7695,7 +7695,7 @@ } } }, -"revision": "20240326", +"revision": "20240401", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 736fb29fe39..e3a1b73fb79 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -1684,6 +1684,34 @@ }, "servingConfigs": { "methods": { +"answer": { +"description": "Answer query method.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer", +"parameterOrder": [ +"servingConfig" +], +"parameters": { +"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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+servingConfig}:answer", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -1837,6 +1865,199 @@ } } }, +"sessions": { +"methods": { +"create": { +"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sessions", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Session.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all Sessions by their parent DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sessions", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "siteSearchEngine": { "methods": { "batchVerifyTargetSites": { @@ -3006,6 +3227,34 @@ }, "servingConfigs": { "methods": { +"answer": { +"description": "Answer query method.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer", +"parameterOrder": [ +"servingConfig" +], +"parameters": { +"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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+servingConfig}:answer", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", @@ -3158,77 +3407,270 @@ ] } } -} -} }, -"operations": { +"sessions": { "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}/collections/{collectionsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.operations.get", +"create": { +"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sessions", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.engines.sessions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "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}/collections/{collectionsId}/operations", +"get": { +"description": "Gets a Session.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.operations.list", +"id": "discoveryengine.projects.locations.collections.engines.sessions.get", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, "name": { -"description": "The name of the operation's parent resource.", +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "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", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} +}, +"list": { +"description": "Lists all Sessions by their parent DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sessions", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.engines.sessions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" +}, +"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}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/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}/collections/{collectionsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.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/[^/]+/collections/[^/]+$", +"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" +] +} } } } @@ -4433,6 +4875,34 @@ }, "servingConfigs": { "methods": { +"answer": { +"description": "Answer query method.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer", +"parameterOrder": [ +"servingConfig" +], +"parameters": { +"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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+servingConfig}:answer", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -4586,112 +5056,305 @@ } } }, -"siteSearchEngine": { +"sessions": { "methods": { -"disableAdvancedSiteSearch": { -"description": "Downgrade from advanced site search to basic site search.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", +"create": { +"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", +"id": "discoveryengine.projects.locations.dataStores.sessions.create", "parameterOrder": [ -"siteSearchEngine" +"parent" ], "parameters": { -"siteSearchEngine": { -"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"parent": { +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch", +"path": "v1alpha/{+parent}/sessions", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest" +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"enableAdvancedSiteSearch": { -"description": "Upgrade from basic site search to advanced site search.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", +"delete": { +"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.dataStores.sessions.delete", "parameterOrder": [ -"siteSearchEngine" +"name" ], "parameters": { -"siteSearchEngine": { -"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"name": { +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest" -}, +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "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}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", +"get": { +"description": "Gets a Session.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.sessions.get", "parameterOrder": [ -"siteSearchEngine" +"name" ], "parameters": { -"siteSearchEngine": { -"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"name": { +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+siteSearchEngine}:recrawlUris", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest" -}, +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"targetSites": { -"methods": { -"batchCreate": { -"description": "Creates TargetSite in a batch.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate", +"list": { +"description": "Lists all Sessions by their parent DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.sessions.list", "parameterOrder": [ "parent" ], "parameters": { -"parent": { -"description": "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.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", -"required": true, -"type": "string" -} +"filter": { +"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sessions", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.sessions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.sessions.answers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"siteSearchEngine": { +"methods": { +"disableAdvancedSiteSearch": { +"description": "Downgrade from advanced site search to basic site search.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"enableAdvancedSiteSearch": { +"description": "Upgrade from basic site search to advanced site search.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"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}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:recrawlUris", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"targetSites": { +"methods": { +"batchCreate": { +"description": "Creates TargetSite in a batch.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "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.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} }, "path": "v1alpha/{+parent}/targetSites:batchCreate", "request": { @@ -5041,6 +5704,71 @@ } } }, +"evaluations": { +"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}/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": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"groundingConfigs": { +"methods": { +"check": { +"description": "Performs a grounding check.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.groundingConfigs.check", +"parameterOrder": [ +"groundingConfig" +], +"parameters": { +"groundingConfig": { +"description": "Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+groundingConfig}:check", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "get": { @@ -5218,7 +5946,7 @@ } } }, -"revision": "20240329", +"revision": "20240401", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5928,6 +6656,11 @@ "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", @@ -6273,84 +7006,872 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"properties": { +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." +} +}, +"type": "object" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"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" +}, +"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.", +"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" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAdditionalParams": { +"description": "AdditionalParams message for WidgetService methods for security and privacy enhancement.", +"id": "GoogleCloudDiscoveryengineV1alphaAdditionalParams", +"properties": { +"token": { +"description": "Token that used for non-human user check.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswer": { +"description": "Defines an answer.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswer", +"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" +], +"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." +], +"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.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"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" +}, +"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.", +"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.", +"format": "int64", +"type": "string" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { +"description": "Citation source.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"properties": { +"referenceId": { +"description": "ID of the citation source.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { +"description": "Request message for ConversationalSearchService.AnswerQuery method.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", +"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 \u201c-\u201d as session id. A new id will be automatically generated and assigned.", +"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`. 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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { +"description": "Answer generation specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", +"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.", +"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" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { +"description": "Answer Generation Model specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", +"properties": { +"modelVersion": { +"description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { +"description": "Answer generation prompt specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", +"properties": { +"preamble": { +"description": "Customized preamble.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { +"description": "Query understanding specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", +"properties": { +"queryClassificationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", +"description": "Query classification specification." +}, +"queryRephraserSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", +"description": "Query rephraser specification." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { +"description": "Query classification specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", +"properties": { +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { +"description": "Query rephraser specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", +"properties": { +"disable": { +"description": "Disable query rephraser.", +"type": "boolean" +}, +"maxRephraseSteps": { +"description": "Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { +"description": "Related questions specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", +"properties": { +"enable": { +"description": "Enable related questions feature if true.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { +"description": "Safety specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", +"properties": { +"enable": { +"description": "Enable the safety filtering on the answer response. It is false by default.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { +"description": "Search specification.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", +"properties": { +"searchParams": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", +"description": "Search parameters." +}, +"searchResultList": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", +"description": "Search result list." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { +"description": "Search parameters.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", +"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)" +}, +"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" +}, +"maxReturnResults": { +"description": "Number of search results to return. The default value is 10.", +"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, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode 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)", +"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" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { +"description": "Search result list.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", +"properties": { +"searchResults": { +"description": "Search results.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { +"description": "Search result.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", +"properties": { +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", +"description": "Chunk information." +}, +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", +"description": "Unstructured document information." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", +"properties": { +"chunk": { +"description": "Chunk resource name.", +"type": "string" +}, +"content": { +"description": "Chunk textual content.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", +"properties": { +"document": { +"description": "Document resource name.", +"type": "string" +}, +"documentContexts": { +"description": "List of document contexts.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" +}, +"type": "array" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { +"description": "Document context.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", +"properties": { +"content": { +"description": "Document content.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { +"description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", +"properties": { +"content": { +"description": "Extractive answer content.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { +"description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", +"properties": { +"content": { +"description": "Extractive segment content.", +"type": "string" +}, +"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.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { +"description": "Query understanding information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"properties": { +"queryClassificationInfo": { +"description": "Query classification information.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { +"description": "Query classification information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", +"properties": { +"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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerReference": { +"description": "Reference.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"properties": { +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"description": "Chunk information." +}, +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"description": "Unstructured document information." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"properties": { +"chunk": { +"description": "Chunk resource name.", +"type": "string" +}, +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"description": "Document metadata." +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"properties": { +"document": { +"description": "Document resource name.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"properties": { +"chunkContents": { +"description": "List of cited chunk contents derived from document content.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" +}, +"type": "array" +}, +"document": { +"description": "Document resource name.", +"type": "string" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { +"description": "Chunk content.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", +"properties": { +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", +"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" +}, +"thought": { +"description": "The thought of the step.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." +"observation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"description": "Observation." +}, +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"description": "Search action." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", -"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" }, -"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"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" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" +}, +"type": "array" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "type": "string" } }, "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", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"chunk": { +"description": "Chunk resource name.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAclConfig": { -"description": "Access Control Configuration.", -"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Identity provider config." +"snippet": { +"description": "Snippet content.", +"type": "string" }, -"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.", +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAdditionalParams": { -"description": "AdditionalParams message for WidgetService methods for security and privacy enhancement.", -"id": "GoogleCloudDiscoveryengineV1alphaAdditionalParams", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "properties": { -"token": { -"description": "Token that used for non-human user check.", +"query": { +"description": "The query to search.", "type": "string" } }, @@ -6412,7 +7933,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "properties": { "dataSchema": { -"description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.", +"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": { @@ -6450,40 +7971,41 @@ "type": "object" }, "keyFieldName": { -"description": "The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9*", +"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" }, "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { +"description": "The column of the Bigtable.", "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", "properties": { "encoding": { -"description": "Optional. 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.", +"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" }, "fieldName": { -"description": "The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined.", +"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" }, "qualifier": { -"description": "Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string.", +"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" }, "type": { -"description": "Optional. 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.", +"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", @@ -6495,14 +8017,14 @@ "JSON" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" +"The type is unspecified.", +"String type.", +"Numerical type.", +"Integer type.", +"Variable length integer type.", +"BigDecimal type.", +"Boolean type.", +"JSON type." ], "type": "string" } @@ -6510,6 +8032,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { +"description": "The column family of the Bigtable.", "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", "properties": { "columns": { @@ -6520,25 +8043,25 @@ "type": "array" }, "encoding": { -"description": "Optional. 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.", +"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" }, "fieldName": { -"description": "The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined.", +"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" }, "type": { -"description": "Optional. 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.", +"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", @@ -6550,14 +8073,14 @@ "JSON" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" +"The type is unspecified.", +"String type.", +"Numerical type.", +"Integer type.", +"Variable length integer type.", +"BigDecimal type.", +"Boolean type.", +"JSON type." ], "type": "string" } @@ -6565,7 +8088,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaBigtableSource": { -"description": "The Cloud Bigtable source for importing data", +"description": "The Cloud Bigtable source for importing data.", "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", "properties": { "bigtableOptions": { @@ -6573,16 +8096,105 @@ "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 exported.", +"description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", "type": "string" }, "projectId": { -"description": "The project ID (can be project # or 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.", +"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 exported.", +"description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { +"description": "Request message for GroundedGenerationService.CheckGrounding method.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", +"properties": { +"answerCandidate": { +"description": "Answer candidate to check.", +"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." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { +"description": "Response message for the GroundedGenerationService.CheckGrounding method.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", +"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.", +"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" +}, +"GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { +"description": "Text and citation info for a claim in the answer candidate.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", +"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.", +"items": { +"format": "int32", +"type": "integer" +}, +"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" +}, +"startPos": { +"description": "Position indicating the start of the claim in the answer candidate, measured in bytes/unicode.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { +"description": "Specification for the grounding check.", +"id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", +"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" } }, "type": "object" @@ -6614,7 +8226,7 @@ "description": "Metadata of the document from the current chunk." }, "id": { -"description": "Unique chunk id of the current chunk.", +"description": "Unique chunk ID of the current chunk.", "type": "string" }, "name": { @@ -6690,7 +8302,7 @@ "type": "string" }, "gcsStagingDir": { -"description": "Optional. 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. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory.", +"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. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" }, "instanceId": { @@ -6698,11 +8310,11 @@ "type": "string" }, "offload": { -"description": "Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless", +"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": "Optional. The project ID (can be project # or 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.", +"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": { @@ -7947,6 +9559,28 @@ }, "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" +}, +"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" +}, "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", @@ -8115,7 +9749,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", "properties": { "collectionId": { -"description": "Required. The Firestore collection to copy the data from with a length limit of 1500 characters.", +"description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.", "type": "string" }, "databaseId": { @@ -8123,11 +9757,11 @@ "type": "string" }, "gcsStagingDir": { -"description": "Optional. 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. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory.", +"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. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" }, "projectId": { -"description": "Optional. The project ID (can be project # or 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.", +"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" } }, @@ -8138,7 +9772,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", +"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 even imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { @@ -8151,12 +9785,19 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaGroundingConfig": { -"description": "Grounding configuration.", -"id": "GoogleCloudDiscoveryengineV1alphaGroundingConfig", +"GoogleCloudDiscoveryengineV1alphaGroundingFact": { +"description": "Grounding Fact.", +"id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", "properties": { -"name": { -"description": "Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`.", +"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" +}, +"factText": { +"description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" } }, @@ -8278,6 +9919,11 @@ "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", @@ -8291,7 +9937,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { "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", +"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": { @@ -8323,7 +9969,7 @@ "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", +"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": { @@ -8347,6 +9993,11 @@ "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" @@ -8709,6 +10360,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { +"description": "Response for ListSessions method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", +"properties": { +"nextPageToken": { +"description": "Pagination token, if not returned indicates the last page.", +"type": "string" +}, +"sessions": { +"description": "All the Sessions for a given data store.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSession" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", @@ -9036,6 +10705,21 @@ }, "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" +}, "GoogleCloudDiscoveryengineV1alphaRankRequest": { "description": "Request message for RankService.Rank method.", "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", @@ -9053,7 +10737,7 @@ "type": "string" }, "records": { -"description": "Required. A list of records to rank.", +"description": "Required. A list of records to rank. At most 100 records to rank.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" }, @@ -9483,7 +11167,7 @@ "type": "string" }, "pageSize": { -"description": "Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"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" }, @@ -9563,6 +11247,10 @@ "format": "float", "type": "number" }, +"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" @@ -9570,6 +11258,66 @@ }, "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", +"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]`. E.g. `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": "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" +}, +"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" +}, +"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", @@ -10463,6 +12211,67 @@ }, "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" +}, +"name": { +"description": "Immutable. Fully qualified name `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" +}, +"GoogleCloudDiscoveryengineV1alphaSessionTurn": { +"description": "Represents a turn, including a query from the user and a answer from service.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", +"properties": { +"answer": { +"description": "The resource name of the answer to the user query.", +"type": "string" +}, +"query": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", +"description": "The user query." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", @@ -10511,7 +12320,7 @@ "type": "string" }, "enableDataBoost": { -"description": "Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas", +"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": { @@ -10749,7 +12558,7 @@ "type": "object" }, "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 is in progress. * **ready**: The model is ready for serving.", +"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" } }, @@ -11934,17 +13743,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaGroundingConfig": { -"description": "Grounding configuration.", -"id": "GoogleCloudDiscoveryengineV1betaGroundingConfig", -"properties": { -"name": { -"description": "Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`.", -"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", @@ -11964,6 +13762,11 @@ "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", @@ -12373,7 +14176,7 @@ "type": "object" }, "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 is in progress. * **ready**: The model is ready for serving.", +"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" } }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 8b978be741b..c5f632dde32 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -1300,6 +1300,34 @@ }, "servingConfigs": { "methods": { +"answer": { +"description": "Answer query method.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.servingConfigs.answer", +"parameterOrder": [ +"servingConfig" +], +"parameters": { +"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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+servingConfig}:answer", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -1453,6 +1481,199 @@ } } }, +"sessions": { +"methods": { +"create": { +"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sessions", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Session.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all Sessions by their parent DataStore.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sessions", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.sessions.answers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "siteSearchEngine": { "methods": { "batchVerifyTargetSites": { @@ -2594,6 +2815,34 @@ }, "servingConfigs": { "methods": { +"answer": { +"description": "Answer query method.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:answer", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.servingConfigs.answer", +"parameterOrder": [ +"servingConfig" +], +"parameters": { +"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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+servingConfig}:answer", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", @@ -2746,77 +2995,270 @@ ] } } -} -} }, -"operations": { +"sessions": { "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}/collections/{collectionsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.operations.get", +"create": { +"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sessions", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.engines.sessions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "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}/locations/{locationsId}/collections/{collectionsId}/operations", +"get": { +"description": "Gets a Session.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.operations.list", +"id": "discoveryengine.projects.locations.collections.engines.sessions.get", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, "name": { -"description": "The name of the operation's parent resource.", +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "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", +"path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} +}, +"list": { +"description": "Lists all Sessions by their parent DataStore.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sessions", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.engines.sessions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswer" +}, +"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}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/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}/locations/{locationsId}/collections/{collectionsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.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/[^/]+/collections/[^/]+$", +"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" +] +} } } } @@ -3836,6 +4278,34 @@ }, "servingConfigs": { "methods": { +"answer": { +"description": "Answer query method.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:answer", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.servingConfigs.answer", +"parameterOrder": [ +"servingConfig" +], +"parameters": { +"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/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+servingConfig}:answer", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -3989,112 +4459,305 @@ } } }, -"siteSearchEngine": { +"sessions": { "methods": { -"disableAdvancedSiteSearch": { -"description": "Downgrade from advanced site search to basic site search.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", +"create": { +"description": "Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", "httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", +"id": "discoveryengine.projects.locations.dataStores.sessions.create", "parameterOrder": [ -"siteSearchEngine" +"parent" ], "parameters": { -"siteSearchEngine": { -"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"parent": { +"description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch", +"path": "v1beta/{+parent}/sessions", "request": { -"$ref": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest" +"$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"enableAdvancedSiteSearch": { -"description": "Upgrade from basic site search to advanced site search.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", +"delete": { +"description": "Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.dataStores.sessions.delete", "parameterOrder": [ -"siteSearchEngine" +"name" ], "parameters": { -"siteSearchEngine": { -"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"name": { +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest" -}, +"path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"recrawlUris": { -"description": "Request on-demand recrawl for a list of URIs.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", +"get": { +"description": "Gets a Session.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.sessions.get", "parameterOrder": [ -"siteSearchEngine" +"name" ], "parameters": { -"siteSearchEngine": { -"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"name": { +"description": "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}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta/{+siteSearchEngine}:recrawlUris", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest" -}, +"path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1betaSession" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"targetSites": { -"methods": { -"batchCreate": { -"description": "Creates TargetSite in a batch.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate", +"list": { +"description": "Lists all Sessions by their parent DataStore.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.sessions.list", "parameterOrder": [ "parent" ], "parameters": { -"parent": { -"description": "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.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", -"required": true, -"type": "string" -} +"filter": { +"description": "A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: \"user_pseudo_id = some_id\"", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: \"update_time desc\" \"create_time\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sessions", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListSessionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.sessions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/sessions/{sessionsId}/answers/{answersId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.sessions.answers.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "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}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswer" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"siteSearchEngine": { +"methods": { +"disableAdvancedSiteSearch": { +"description": "Downgrade from advanced site search to basic site search.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:disableAdvancedSiteSearch", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.disableAdvancedSiteSearch", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"enableAdvancedSiteSearch": { +"description": "Upgrade from basic site search to advanced site search.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:enableAdvancedSiteSearch", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.enableAdvancedSiteSearch", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"recrawlUris": { +"description": "Request on-demand recrawl for a list of URIs.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+siteSearchEngine}:recrawlUris", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"targetSites": { +"methods": { +"batchCreate": { +"description": "Creates TargetSite in a batch.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/targetSites:batchCreate", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.targetSites.batchCreate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "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.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} }, "path": "v1beta/{+parent}/targetSites:batchCreate", "request": { @@ -4416,6 +5079,38 @@ } } }, +"groundingConfigs": { +"methods": { +"check": { +"description": "Performs a grounding check.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/groundingConfigs/{groundingConfigsId}:check", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.groundingConfigs.check", +"parameterOrder": [ +"groundingConfig" +], +"parameters": { +"groundingConfig": { +"description": "Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/groundingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+groundingConfig}:check", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "get": { @@ -4593,7 +5288,7 @@ } } }, -"revision": "20240329", +"revision": "20240401", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5303,6 +5998,11 @@ "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", @@ -5720,397 +6420,475 @@ }, "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", +"GoogleCloudDiscoveryengineV1alphaAnswer": { +"description": "Defines an answer.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"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" +], +"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." +], "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": "array" }, -"type": "object" +"answerText": { +"description": "The textual answer.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", -"properties": { -"targetSites": { -"description": "TargetSites created.", +"citations": { +"description": "Citations.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" }, "type": "array" -} }, -"type": "object" +"completeTime": { +"description": "Output only. Answer completed timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"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.", +"description": "Output only. Answer creation timestamp.", "format": "google-datetime", +"readOnly": true, "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. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" -} }, -"type": "object" +"queryUnderstandingInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"description": "Query understanding information." }, -"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": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"references": { +"description": "References.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" +}, +"type": "array" +}, +"relatedQuestions": { +"description": "Suggested related questions.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"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.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", +"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" }, -"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", +"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { +"description": "Citation source.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"referenceId": { +"description": "ID of the citation source.", "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" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { +"description": "Query understanding information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"properties": { +"queryClassificationInfo": { +"description": "Query classification information.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaDataStore", +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { +"description": "Query classification information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "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.", +"positive": { +"description": "Classification output.", "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.", +"type": { +"description": "Query classification type.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"TYPE_UNSPECIFIED", +"ADVERSARIAL_QUERY", +"NON_ANSWER_SEEKING_QUERY" ], "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." +"Unspecified query classification type.", +"Adversarial query classification type.", +"Non-answer-seeking query classification type." ], "type": "string" +} }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "object" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, +"GoogleCloudDiscoveryengineV1alphaAnswerReference": { +"description": "Reference.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"properties": { +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"description": "Chunk information." +}, +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"description": "Unstructured document information." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"properties": { +"chunk": { +"description": "Chunk resource name.", "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.", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"description": "Document metadata." }, -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Output only. Data store level identity provider config.", -"readOnly": true +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" +} }, -"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" +"type": "object" }, -"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.", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"properties": { +"document": { +"description": "Document resource name.", "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." -], +"pageIdentifier": { +"description": "Page identifier.", "type": "string" }, -"type": "array" +"title": { +"description": "Title.", +"type": "string" }, -"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)." +"uri": { +"description": "URI for the document.", +"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", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"chunkContents": { +"description": "List of cited chunk contents derived from document content.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" +}, +"type": "array" +}, +"document": { +"description": "Document resource name.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "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", +"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" }, -"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"actions": { +"description": "Actions.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" +}, +"type": "array" +}, +"description": { +"description": "The description of the step.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"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" }, -"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", +"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"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" }, -"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", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { -"createTime": { -"description": "Operation create 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" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" } }, "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", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, -"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." +"type": "array" }, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"document": { +"description": "Document resource name.", "type": "string" }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" }, -"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": "array" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"chunk": { +"description": "Chunk resource name.", +"type": "string" +}, +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"snippet": { +"description": "Snippet content.", +"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" +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." -}, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." -}, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +"query": { +"description": "The query to search.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"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", +"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" +} }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { -"enhancedDocumentElements": { -"description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", +"targetSites": { +"description": "TargetSites created.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" +} }, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" +"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" }, -"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", +"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": { "createTime": { "description": "Operation create time.", @@ -6125,48 +6903,90 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", +"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" }, -"GoogleCloudDiscoveryengineV1alphaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngine", +"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": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"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 Recommendation Engine was created at.", +"description": "Output only. Timestamp the DataStore 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": { +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, "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.", +"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": "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 liniked to the engine.", +"description": "Immutable. The industry vertical that the data store registers.", "enum": [ "INDUSTRY_VERTICAL_UNSPECIFIED", "GENERIC", @@ -6181,29 +7001,13 @@ ], "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.", +"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" }, -"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.", +"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", @@ -6220,1093 +7024,2251 @@ ], "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, -"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", +"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" +}, +"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": { +"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" +}, +"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", +"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" +}, +"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": { +"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" +}, +"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" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"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", +"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" +}, +"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" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"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" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"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", +"properties": { +"enhancedDocumentElements": { +"description": "Apply additional enhanced OCR processing to a list of document elements. Supported values: * `table`: advanced table parsing model.", +"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" +}, +"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": { +"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" +}, +"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" +}, +"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 liniked 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." +], +"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. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"type": "string" +} +}, +"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", +"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" +}, +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"properties": { +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"properties": { +"companyName": { +"description": "Immutable. 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" +}, +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { +"description": "Additional config specs for a Media Recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"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" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { +"description": "Custom threshold for `cvr` optimization_objective.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"properties": { +"targetField": { +"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", +"type": "string" +}, +"targetFieldValueFloat": { +"description": "Required. The threshold to be applied to the target (e.g., 0.5).", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { +"description": "Additional information of a recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"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" +}, +"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_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, please 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", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +} +}, +"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", +"properties": { +"dataSizeBytes": { +"description": "Data size in terms of bytes.", +"format": "int64", +"type": "string" +}, +"documentCount": { +"description": "Total number of documents.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaFieldConfig": { +"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", +"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"properties": { +"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.", +"Field value type is 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." +], +"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" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfig": { +"description": "Identity Provider Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"properties": { +"externalIdpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"description": "External Identity provider config." +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { +"description": "Third party IDP Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"properties": { +"workforcePoolName": { +"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", +"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", +"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" +}, +"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": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"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" +} +}, +"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", +"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" +}, +"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": { +"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": "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.", +"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", +"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" +}, +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", +"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", +"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" +}, +"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": { +"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" +}, +"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" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"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", +"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" +}, +"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", +"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" +}, +"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", +"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" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { +"description": "Response message for SiteSearchEngineService.RecrawlUris method.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", +"properties": { +"failedUris": { +"description": "URIs that were not crawled before the LRO terminated.", +"items": { +"type": "string" +}, +"type": "array" +}, +"failureSamples": { +"description": "Details for a sample of up to 10 `failed_uris`.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" +}, +"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", +"properties": { +"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" +}, +"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": { +"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" +}, +"errorMessage": { +"description": "Reason why the URI was not crawled.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1alphaSchema", "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." +"fieldConfigs": { +"description": "Output only. Configurations for fields of the schema.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" }, -"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. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"readOnly": true, +"type": "array" +}, +"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" }, -"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", +"GoogleCloudDiscoveryengineV1alphaSession": { +"description": "External session proto definition.", +"id": "GoogleCloudDiscoveryengineV1alphaSession", "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.", +"endTime": { +"description": "Output only. The time the session finished.", +"format": "google-datetime", +"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.", +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "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.", +"startTime": { +"description": "Output only. The time the session started.", +"format": "google-datetime", +"readOnly": true, "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.", +"state": { +"description": "The state of the session.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS" +], +"enumDescriptions": [ +"State is unspecified.", +"The session is currently open." +], "type": "string" -} }, -"type": "object" +"turns": { +"description": "Turns.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", -"properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"type": "array" +}, +"userPseudoId": { +"description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaSessionTurn": { +"description": "Represents a turn, including a query from the user and a answer from service.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { -"companyName": { -"description": "Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"answer": { +"description": "The resource name of the answer to the user query.", "type": "string" +}, +"query": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", +"description": "The user query." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { -"description": "Additional config specs for a Media Recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "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.", +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", "enum": [ -"TRAINING_STATE_UNSPECIFIED", -"PAUSED", -"TRAINING" +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" ], "enumDescriptions": [ -"Unspecified training state.", -"The engine training is paused.", -"The engine is training." +"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" }, -"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`.", +"verifyTime": { +"description": "Latest site verification time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { -"description": "Custom threshold for `cvr` optimization_objective.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"GoogleCloudDiscoveryengineV1alphaTargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { -"targetField": { -"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", -"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" }, -"targetFieldValueFloat": { -"description": "Required. The threshold to be applied to the target (e.g., 0.5).", -"format": "float", -"type": "number" -} +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true }, -"type": "object" +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { -"description": "Additional information of a recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", -"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.", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"DATA_STATE_UNSPECIFIED", -"DATA_OK", -"DATA_ERROR" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "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." +"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" }, -"lastTuneTime": { -"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", -"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" }, -"servingState": { -"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"type": "string" +}, +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", +"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": [ -"SERVING_STATE_UNSPECIFIED", -"INACTIVE", -"ACTIVE", -"TUNED" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "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." +"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" +}, +"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" +}, +"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.", +"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" +}, +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", +"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.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" }, -"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, +"description": "The metrics of the trained model.", +"type": "object" +}, +"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" }, -"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { +"description": "Metadata associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "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, please 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." -], +"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" }, -"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { -"description": "Additional config specs for a `similar-items` engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { +"description": "Response associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", "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", +"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "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" }, -"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", +"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": { -"dataSizeBytes": { -"description": "Data size in terms of bytes.", -"format": "int64", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"documentCount": { -"description": "Total number of documents.", -"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" }, -"GoogleCloudDiscoveryengineV1alphaFieldConfig": { -"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", -"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"GoogleCloudDiscoveryengineV1betaAnswer": { +"description": "Defines an answer.", +"id": "GoogleCloudDiscoveryengineV1betaAnswer", "properties": { -"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.", +"answerSkippedReasons": { +"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", +"items": { "enum": [ -"COMPLETABLE_OPTION_UNSPECIFIED", -"COMPLETABLE_ENABLED", -"COMPLETABLE_DISABLED" +"ANSWER_SKIPPED_REASON_UNSPECIFIED", +"ADVERSARIAL_QUERY_IGNORED", +"NON_ANSWER_SEEKING_QUERY_IGNORED", +"OUT_OF_DOMAIN_QUERY_IGNORED", +"POTENTIAL_POLICY_VIOLATION" ], "enumDescriptions": [ -"Value used when unset.", -"Completable option enabled for a schema field.", -"Completable option disabled for a schema field." +"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." ], "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" +"type": "array" }, -"fieldPath": { -"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", +"answerText": { +"description": "The textual answer.", "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.", -"Field value type is Datetime." -], -"readOnly": true, -"type": "string" +"citations": { +"description": "Citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitation" }, -"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" +"type": "array" }, -"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.", +"completeTime": { +"description": "Output only. Answer completed timestamp.", +"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." -], +"createTime": { +"description": "Output only. Answer creation timestamp.", +"format": "google-datetime", +"readOnly": true, "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." -], +"name": { +"description": "Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "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.", -"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" -} +"queryUnderstandingInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo", +"description": "Query understanding information." }, -"type": "object" +"references": { +"description": "References.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReference" }, -"GoogleCloudDiscoveryengineV1alphaGroundingConfig": { -"description": "Grounding configuration.", -"id": "GoogleCloudDiscoveryengineV1alphaGroundingConfig", -"properties": { -"name": { -"description": "Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`.", -"type": "string" -} +"type": "array" }, -"type": "object" +"relatedQuestions": { +"description": "Suggested related questions.", +"items": { +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfig": { -"description": "Identity Provider Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"properties": { -"externalIdpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", -"description": "External Identity provider config." +"type": "array" }, -"idpType": { -"description": "Identity provider type configured.", +"state": { +"description": "The state of the answer generation.", "enum": [ -"IDP_TYPE_UNSPECIFIED", -"GSUITE", -"THIRD_PARTY" +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" ], "enumDescriptions": [ -"Default value. ACL search not enabled.", -"Google 1P provider.", -"Third party provider." +"Unknown.", +"Answer generation is currently in progress.", +"Answer generation currently failed.", +"Answer generation has succeeded." ], "type": "string" -} }, -"type": "object" +"steps": { +"description": "Answer generation steps.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStep" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { -"description": "Third party IDP Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", -"properties": { -"workforcePoolName": { -"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", -"type": "string" +"type": "array" } }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerCitation": { +"description": "Citation info for a segment.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerCitation", "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", +"endIndex": { +"description": "End of the attributed segment, exclusive.", +"format": "int64", "type": "string" -} -}, -"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": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"sources": { +"description": "Citation sources for the attributed segment.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource" }, "type": "array" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", +"startIndex": { +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", "format": "int64", "type": "string" +} }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAnswerCitationSource": { +"description": "Citation source.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerCitationSource", +"properties": { +"referenceId": { +"description": "ID of the citation source.", "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequest": { +"description": "Request message for ConversationalSearchService.AnswerQuery method.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequest", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"answerGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec", +"description": "Answer generation specification." }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"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" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"query": { +"$ref": "GoogleCloudDiscoveryengineV1betaQuery", +"description": "Required. Current user query." +}, +"queryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec", +"description": "Query understanding specification." +}, +"relatedQuestionsSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec", +"description": "Related questions specification." +}, +"safetySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec", +"description": "Model specification." +}, +"searchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec", +"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 \u201c-\u201d 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", +"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" }, -"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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec": { +"description": "Answer generation specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." +"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" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"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" }, -"type": "array" +"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": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec", +"description": "Answer generation model specification." +}, +"promptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec", +"description": "Answer generation prompt specification." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec": { +"description": "Answer Generation Model specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec", "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.", +"modelVersion": { +"description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { +"description": "Answer generation prompt specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec", "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": "Customized preamble.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec": { +"description": "Query understanding specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"queryClassificationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", +"description": "Query classification specification." }, -"type": "array" +"queryRephraserSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", +"description": "Query rephraser specification." +} }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", -"type": "string" +"type": "object" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { +"description": "Query classification specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", +"properties": { +"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" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { +"description": "Query rephraser specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"disable": { +"description": "Disable query rephraser.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"maxRephraseSteps": { +"description": "Max rephrase steps. The max number is 10 steps. If not set or set to < 1, it will be set to 1 by default.", +"format": "int32", +"type": "integer" +} }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"type": "object" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec": { +"description": "Related questions specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec", +"properties": { +"enable": { +"description": "Enable related questions feature if true.", +"type": "boolean" } }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec": { +"description": "Safety specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec", "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" +"enable": { +"description": "Enable the safety filtering on the answer response. It is false by default.", +"type": "boolean" +} }, -"type": "array" +"type": "object" }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", -"type": "string" +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec": { +"description": "Search specification.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec", +"properties": { +"searchParams": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams", +"description": "Search parameters." }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" +"searchResultList": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList", +"description": "Search result list." } }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams": { +"description": "Search parameters.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams", "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" +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"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)" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"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" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", -"type": "string" +"maxReturnResults": { +"description": "Number of search results to return. The default value is 10.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"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" } }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList": { +"description": "Search result list.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList", "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.", +"searchResults": { +"description": "Search results.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult" }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { +"description": "Search result.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", +"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": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", +"description": "Unstructured document information." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" +"chunk": { +"description": "Chunk resource name.", +"type": "string" }, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"content": { +"description": "Chunk textual content.", "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", "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", -"type": "string" +"documentContexts": { +"description": "List of document contexts.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"type": "array" +}, +"extractiveAnswers": { +"description": "List of extractive answers.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" +}, +"type": "array" +}, +"extractiveSegments": { +"description": "List of extractive segments.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" +}, +"type": "array" +}, +"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" }, -"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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { +"description": "Document context.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { -"purgeCount": { -"description": "The total count of events purged as a result of the operation.", -"format": "int64", +"content": { +"description": "Document content.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { +"description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"content": { +"description": "Extractive answer content.", "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": { +"pageIdentifier": { +"description": "Page identifier.", "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" +"type": "object" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { +"description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", +"properties": { +"content": { +"description": "Extractive segment content.", "type": "string" }, -"validUrisCount": { -"description": "Total number of unique URIs in the request that are not in invalid_uris.", -"format": "int32", -"type": "integer" +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { -"description": "Response message for SiteSearchEngineService.RecrawlUris method.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", +"GoogleCloudDiscoveryengineV1betaAnswerQueryResponse": { +"description": "Response message for ConversationalSearchService.AnswerQuery method.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryResponse", "properties": { -"failedUris": { -"description": "URIs that were not crawled before the LRO terminated.", -"items": { -"type": "string" -}, -"type": "array" -}, -"failureSamples": { -"description": "Details for a sample of up to 10 `failed_uris`.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" +"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." }, -"type": "array" +"session": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession", +"description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { -"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", +"GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo": { +"description": "Query understanding information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo", "properties": { -"failureReasons": { -"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", +"queryClassificationInfo": { +"description": "Query classification information.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo" }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo": { +"description": "Query classification information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo", "properties": { -"corpusType": { -"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"positive": { +"description": "Classification output.", +"type": "boolean" +}, +"type": { +"description": "Query classification type.", "enum": [ -"CORPUS_TYPE_UNSPECIFIED", -"DESKTOP", -"MOBILE" +"TYPE_UNSPECIFIED", +"ADVERSARIAL_QUERY", +"NON_ANSWER_SEEKING_QUERY" ], "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 classification type.", +"Adversarial query classification type.", +"Non-answer-seeking query classification type." ], "type": "string" -}, -"errorMessage": { -"description": "Reason why the URI was not crawled.", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1alphaSchema", +"GoogleCloudDiscoveryengineV1betaAnswerReference": { +"description": "Reference.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerReference", "properties": { -"fieldConfigs": { -"description": "Output only. Configurations for fields of the schema.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo", +"description": "Chunk information." }, -"readOnly": true, -"type": "array" +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo", +"description": "Unstructured document information." +} }, -"jsonSchema": { -"description": "The JSON representation of the schema.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo", +"properties": { +"chunk": { +"description": "Chunk resource name.", "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.", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata", +"description": "Document metadata." }, -"description": "The structured representation of the schema.", -"type": "object" +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", +"GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata", "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." -], +"document": { +"description": "Document resource name.", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", +"GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo", "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" +"chunkContents": { +"description": "List of cited chunk contents derived from document content.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true +"type": "array" }, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, +"document": { +"description": "Document resource name.", "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, +"title": { +"description": "Title.", "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, +"uri": { +"description": "URI for the document.", "type": "string" +} }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent": { +"description": "Chunk content.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent", +"properties": { +"content": { +"description": "Chunk textual content.", "type": "string" }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +} }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerStep", +"properties": { +"actions": { +"description": "Actions.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepAction" +}, +"type": "array" +}, +"description": { +"description": "The description of the step.", +"type": "string" +}, +"state": { +"description": "The state of the step.", "enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" ], "enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." +"Unknown.", +"Step is currently in progress.", +"Step currently failed.", +"Step has succeeded." ], "type": "string" }, -"updateTime": { -"description": "Output only. The target site's last updated time.", -"format": "google-datetime", -"readOnly": true, +"thought": { +"description": "The thought of the step.", "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" +}, +"GoogleCloudDiscoveryengineV1betaAnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerStepAction", +"properties": { +"observation": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation", +"description": "Observation." +}, +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction", +"description": "Search action." } }, "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", +"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation", "properties": { -"createTime": { -"description": "Operation create 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": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { -"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", +"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult", "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.", +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo" }, "type": "array" }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" +"document": { +"description": "Document resource name.", +"type": "string" }, -"description": "The metrics of the trained model.", -"type": "object" +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo" }, -"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 is in progress. * **ready**: The model is ready for serving.", +"type": "array" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { -"description": "Metadata associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo", "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}`", +"chunk": { +"description": "Chunk resource name.", "type": "string" -} }, -"type": "object" +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" +} }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { -"description": "Response associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"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" }, -"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", +"GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction", "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", +"query": { +"description": "The query to search.", "type": "string" } }, @@ -7368,7 +9330,7 @@ "id": "GoogleCloudDiscoveryengineV1betaBigQuerySource", "properties": { "dataSchema": { -"description": "The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder.", +"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": { @@ -7406,40 +9368,41 @@ "type": "object" }, "keyFieldName": { -"description": "The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9*", +"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" }, "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn": { +"description": "The column of the Bigtable.", "id": "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn", "properties": { "encoding": { -"description": "Optional. 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.", +"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" }, "fieldName": { -"description": "The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined.", +"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" }, "qualifier": { -"description": "Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string.", +"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" }, "type": { -"description": "Optional. 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.", +"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", @@ -7451,14 +9414,14 @@ "JSON" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" +"The type is unspecified.", +"String type.", +"Numerical type.", +"Integer type.", +"Variable length integer type.", +"BigDecimal type.", +"Boolean type.", +"JSON type." ], "type": "string" } @@ -7466,6 +9429,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily": { +"description": "The column family of the Bigtable.", "id": "GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily", "properties": { "columns": { @@ -7476,25 +9440,25 @@ "type": "array" }, "encoding": { -"description": "Optional. 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.", +"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" }, "fieldName": { -"description": "The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined.", +"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" }, "type": { -"description": "Optional. 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.", +"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", @@ -7506,14 +9470,14 @@ "JSON" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" +"The type is unspecified.", +"String type.", +"Numerical type.", +"Integer type.", +"Variable length integer type.", +"BigDecimal type.", +"Boolean type.", +"JSON type." ], "type": "string" } @@ -7521,7 +9485,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaBigtableSource": { -"description": "The Cloud Bigtable source for importing data", +"description": "The Cloud Bigtable source for importing data.", "id": "GoogleCloudDiscoveryengineV1betaBigtableSource", "properties": { "bigtableOptions": { @@ -7529,16 +9493,105 @@ "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 exported.", +"description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", "type": "string" }, "projectId": { -"description": "The project ID (can be project # or 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.", +"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 exported.", +"description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCheckGroundingRequest": { +"description": "Request message for GroundedGenerationService.CheckGrounding method.", +"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingRequest", +"properties": { +"answerCandidate": { +"description": "Answer candidate to check.", +"type": "string" +}, +"facts": { +"description": "List of facts for the grounding check. We support up to 200 facts.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaGroundingFact" +}, +"type": "array" +}, +"groundingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec", +"description": "Configuration of the grounding check." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCheckGroundingResponse": { +"description": "Response message for the GroundedGenerationService.CheckGrounding method.", +"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponse", +"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": "GoogleCloudDiscoveryengineV1betaFactChunk" +}, +"type": "array" +}, +"claims": { +"description": "Claim texts and citation info across all claims in the answer candidate.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim" +}, +"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" +}, +"GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim": { +"description": "Text and citation info for a claim in the answer candidate.", +"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim", +"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.", +"items": { +"format": "int32", +"type": "integer" +}, +"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" +}, +"startPos": { +"description": "Position indicating the start of the claim in the answer candidate, measured in bytes/unicode.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCheckGroundingSpec": { +"description": "Specification for the grounding check.", +"id": "GoogleCloudDiscoveryengineV1betaCheckGroundingSpec", +"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" } }, "type": "object" @@ -7552,7 +9605,7 @@ "type": "string" }, "gcsStagingDir": { -"description": "Optional. 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. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory.", +"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. Please ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" }, "instanceId": { @@ -7560,11 +9613,11 @@ "type": "string" }, "offload": { -"description": "Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless", +"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": "Optional. The project ID (can be project # or 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.", +"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": { @@ -8475,6 +10528,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaFactChunk": { +"description": "Fact Chunk.", +"id": "GoogleCloudDiscoveryengineV1betaFactChunk", +"properties": { +"chunkText": { +"description": "Text content of the fact chunk. Can be at most 10K characters long.", +"type": "string" +}, +"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" +}, "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse": { "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", "id": "GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse", @@ -8518,7 +10593,7 @@ "id": "GoogleCloudDiscoveryengineV1betaFirestoreSource", "properties": { "collectionId": { -"description": "Required. The Firestore collection to copy the data from with a length limit of 1500 characters.", +"description": "Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.", "type": "string" }, "databaseId": { @@ -8526,11 +10601,11 @@ "type": "string" }, "gcsStagingDir": { -"description": "Optional. 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. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory.", +"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. Please ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" }, "projectId": { -"description": "Optional. The project ID (can be project # or 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.", +"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" } }, @@ -8541,7 +10616,7 @@ "id": "GoogleCloudDiscoveryengineV1betaGcsSource", "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 Gen App Builder. * `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 Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line.", +"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 even imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, "inputUris": { @@ -8554,12 +10629,19 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaGroundingConfig": { -"description": "Grounding configuration.", -"id": "GoogleCloudDiscoveryengineV1betaGroundingConfig", +"GoogleCloudDiscoveryengineV1betaGroundingFact": { +"description": "Grounding Fact.", +"id": "GoogleCloudDiscoveryengineV1betaGroundingFact", "properties": { -"name": { -"description": "Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`.", +"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" +}, +"factText": { +"description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" } }, @@ -8584,6 +10666,11 @@ "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", @@ -8597,7 +10684,7 @@ "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsRequest", "properties": { "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", +"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": { @@ -8629,7 +10716,7 @@ "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", +"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": { @@ -8653,6 +10740,11 @@ "spannerSource": { "$ref": "GoogleCloudDiscoveryengineV1betaSpannerSource", "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" @@ -8997,6 +11089,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaListSessionsResponse": { +"description": "Response for ListSessions method.", +"id": "GoogleCloudDiscoveryengineV1betaListSessionsResponse", +"properties": { +"nextPageToken": { +"description": "Pagination token, if not returned indicates the last page.", +"type": "string" +}, +"sessions": { +"description": "All the Sessions for a given data store.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSession" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse": { "description": "Response message for SiteSearchEngineService.ListTargetSites method.", "id": "GoogleCloudDiscoveryengineV1betaListTargetSitesResponse", @@ -9199,6 +11309,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaQuery": { +"description": "Defines a user inputed query.", +"id": "GoogleCloudDiscoveryengineV1betaQuery", +"properties": { +"queryId": { +"description": "Unique Id for the query.", +"type": "string" +}, +"text": { +"description": "Plain text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaRankRequest": { "description": "Request message for RankService.Rank method.", "id": "GoogleCloudDiscoveryengineV1betaRankRequest", @@ -9216,7 +11341,7 @@ "type": "string" }, "records": { -"description": "Required. A list of records to rank.", +"description": "Required. A list of records to rank. At most 100 records to rank.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaRankingRecord" }, @@ -9526,7 +11651,7 @@ "type": "string" }, "pageSize": { -"description": "Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 are coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"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" }, @@ -9602,6 +11727,10 @@ "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" @@ -9609,6 +11738,66 @@ }, "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]`. E.g. `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", @@ -10455,6 +12644,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSession": { +"description": "External session proto definition.", +"id": "GoogleCloudDiscoveryengineV1betaSession", +"properties": { +"endTime": { +"description": "Output only. The time the session finished.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Fully qualified name `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": "GoogleCloudDiscoveryengineV1betaSessionTurn" +}, +"type": "array" +}, +"userPseudoId": { +"description": "A unique identifier for tracking users.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSessionTurn": { +"description": "Represents a turn, including a query from the user and a answer from service.", +"id": "GoogleCloudDiscoveryengineV1betaSessionTurn", +"properties": { +"answer": { +"description": "The resource name of the answer to the user query.", +"type": "string" +}, +"query": { +"$ref": "GoogleCloudDiscoveryengineV1betaQuery", +"description": "The user query." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1betaSiteSearchEngine", @@ -10503,7 +12753,7 @@ "type": "string" }, "enableDataBoost": { -"description": "Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas", +"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": { @@ -10741,7 +12991,7 @@ "type": "object" }, "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 is in progress. * **ready**: The model is ready for serving.", +"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" } }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index a99b690ad50..8b0c9d01afa 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -9267,7 +9267,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -14096,6 +14096,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -14179,6 +14180,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -14287,6 +14289,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -14370,6 +14373,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -14479,6 +14483,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -14562,6 +14567,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -14672,6 +14678,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -14755,6 +14762,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -15716,6 +15724,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -15799,6 +15808,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -16625,6 +16635,7 @@ true "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -16708,6 +16719,7 @@ true "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index d964075991b..40303c0dded 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9222,7 +9222,7 @@ } } }, -"revision": "20240328", +"revision": "20240404", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10042,6 +10042,7 @@ "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -10125,6 +10126,7 @@ "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -14808,6 +14810,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -14891,6 +14894,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -14999,6 +15003,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -15082,6 +15087,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -15191,6 +15197,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -15274,6 +15281,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -15384,6 +15392,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -15467,6 +15476,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -16428,6 +16438,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -16511,6 +16522,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", @@ -17315,6 +17327,7 @@ false "EXCHANGE_CONNATIX", "EXCHANGE_RESET_DIGITAL", "EXCHANGE_HIVESTACK", +"EXCHANGE_DRAX", "EXCHANGE_APPLOVIN_GBID", "EXCHANGE_FYBER_GBID", "EXCHANGE_UNITY_GBID", @@ -17398,6 +17411,7 @@ false "Connatix.", "Reset Digital.", "Hivestack.", +"Drax.", "AppLovin MAX.", "DT Fairbid.", "Unity LevelPlay.", diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 113dfe07619..ce3a67cad09 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -584,6 +584,51 @@ } } }, +"connections": { +"methods": { +"search": { +"description": "Searches for Connections in a parent.", +"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections:search", +"httpMethod": "GET", +"id": "dlp.organizations.locations.connections.search", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Number of results per page, max 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent name, typically an organization, without location. For example: \"organizations/12345678\".", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/connections:search", +"response": { +"$ref": "GooglePrivacyDlpV2SearchConnectionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "deidentifyTemplates": { "methods": { "create": { @@ -1526,6 +1571,31 @@ }, "tableDataProfiles": { "methods": { +"delete": { +"description": "Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.", +"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}", +"httpMethod": "DELETE", +"id": "dlp.organizations.locations.tableDataProfiles.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of the table data profile.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a table data profile.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}", @@ -2650,6 +2720,198 @@ } } }, +"connections": { +"methods": { +"create": { +"description": "Create a Connection to an external data source.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections", +"httpMethod": "POST", +"id": "dlp.projects.locations.connections.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Parent resource name in the format: \"projects/{project}/locations/{location}\".", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/connections", +"request": { +"$ref": "GooglePrivacyDlpV2CreateConnectionRequest" +}, +"response": { +"$ref": "GooglePrivacyDlpV2Connection" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Delete a Connection.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}", +"httpMethod": "DELETE", +"id": "dlp.projects.locations.connections.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of the Connection to be deleted, in the format: \"projects/{project}/locations/{location}/connections/{connection}\".", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Get a Connection by name.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}", +"httpMethod": "GET", +"id": "dlp.projects.locations.connections.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name in the format: \"projects/{project}/locations/{location}/connections/{connection}\".", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GooglePrivacyDlpV2Connection" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Connections in a parent.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections", +"httpMethod": "GET", +"id": "dlp.projects.locations.connections.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Number of results per page, max 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent name, for example: \"projects/project-id/locations/global\".", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/connections", +"response": { +"$ref": "GooglePrivacyDlpV2ListConnectionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Update a Connection.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections/{connectionsId}", +"httpMethod": "PATCH", +"id": "dlp.projects.locations.connections.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name in the format: \"projects/{project}/locations/{location}/connections/{connection}\".", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "GooglePrivacyDlpV2UpdateConnectionRequest" +}, +"response": { +"$ref": "GooglePrivacyDlpV2Connection" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"search": { +"description": "Searches for Connections in a parent.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections:search", +"httpMethod": "GET", +"id": "dlp.projects.locations.connections.search", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. * Supported fields/values - `state` - MISSING|AVAILABLE|ERROR", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Number of results per page, max 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent name, typically an organization, without location. For example: \"organizations/12345678\".", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/connections:search", +"response": { +"$ref": "GooglePrivacyDlpV2SearchConnectionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "content": { "methods": { "deidentify": { @@ -3930,6 +4192,31 @@ }, "tableDataProfiles": { "methods": { +"delete": { +"description": "Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}", +"httpMethod": "DELETE", +"id": "dlp.projects.locations.tableDataProfiles.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of the table data profile.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tableDataProfiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets a table data profile.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/tableDataProfiles/{tableDataProfilesId}", @@ -4164,7 +4451,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -4231,6 +4518,12 @@ "properties": {}, "type": "object" }, +"GooglePrivacyDlpV2AllOtherDatabaseResources": { +"description": "Match database resources not covered by any other filter.", +"id": "GooglePrivacyDlpV2AllOtherDatabaseResources", +"properties": {}, +"type": "object" +}, "GooglePrivacyDlpV2AllText": { "description": "Apply to all text.", "id": "GooglePrivacyDlpV2AllText", @@ -4730,6 +5023,73 @@ }, "type": "object" }, +"GooglePrivacyDlpV2CloudSqlDiscoveryTarget": { +"description": "Target used to match against for discovery with Cloud SQL tables.", +"id": "GooglePrivacyDlpV2CloudSqlDiscoveryTarget", +"properties": { +"conditions": { +"$ref": "GooglePrivacyDlpV2DiscoveryCloudSqlConditions", +"description": "In addition to matching the filter, these conditions must be true before a profile is generated." +}, +"disabled": { +"$ref": "GooglePrivacyDlpV2Disabled", +"description": "Disable profiling for database resources that match this filter." +}, +"filter": { +"$ref": "GooglePrivacyDlpV2DiscoveryCloudSqlFilter", +"description": "Required. The tables the discovery cadence applies to. The first target with a matching filter will be the one to apply to a table." +}, +"generationCadence": { +"$ref": "GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence", +"description": "How often and when to update profiles. New tables that match both the filter and conditions are scanned as quickly as possible depending on system capacity." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2CloudSqlIamCredential": { +"description": "Use IAM auth to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication.", +"id": "GooglePrivacyDlpV2CloudSqlIamCredential", +"properties": {}, +"type": "object" +}, +"GooglePrivacyDlpV2CloudSqlProperties": { +"description": "Cloud SQL connection properties.", +"id": "GooglePrivacyDlpV2CloudSqlProperties", +"properties": { +"cloudSqlIam": { +"$ref": "GooglePrivacyDlpV2CloudSqlIamCredential", +"description": "Built-in IAM authentication (must be configured in Cloud SQL)." +}, +"connectionName": { +"description": "Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name \"project-id:us-central1:sql-instance\" must be created under the parent \"projects/project-id/locations/us-central1\"", +"type": "string" +}, +"databaseEngine": { +"description": "Required. The database engine used by the Cloud SQL instance that this connection configures.", +"enum": [ +"DATABASE_ENGINE_UNKNOWN", +"DATABASE_ENGINE_MYSQL", +"DATABASE_ENGINE_POSTGRES" +], +"enumDescriptions": [ +"An engine that is not currently supported by SDP.", +"Cloud SQL for MySQL instance.", +"Cloud SQL for Postgres instance." +], +"type": "string" +}, +"maxConnections": { +"description": "Required. DLP will limit its connections to max_connections. Must be 2 or greater.", +"format": "int32", +"type": "integer" +}, +"usernamePassword": { +"$ref": "GooglePrivacyDlpV2SecretManagerCredential", +"description": "A username and password stored in Secret Manager." +} +}, +"type": "object" +}, "GooglePrivacyDlpV2CloudStorageFileSet": { "description": "Message representing a set of files in Cloud Storage.", "id": "GooglePrivacyDlpV2CloudStorageFileSet", @@ -5103,6 +5463,46 @@ }, "type": "object" }, +"GooglePrivacyDlpV2Connection": { +"description": "A data connection to allow DLP to profile data in locations that require additional configuration.", +"id": "GooglePrivacyDlpV2Connection", +"properties": { +"cloudSql": { +"$ref": "GooglePrivacyDlpV2CloudSqlProperties", +"description": "Connect to a Cloud SQL instance." +}, +"errors": { +"description": "Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.", +"items": { +"$ref": "GooglePrivacyDlpV2Error" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. Name of the connection: projects/{project}/locations/{location}/connections/{name}.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Required. The connection's state in its lifecycle.", +"enum": [ +"CONNECTION_STATE_UNSPECIFIED", +"MISSING_CREDENTIALS", +"AVAILABLE", +"ERROR" +], +"enumDescriptions": [ +"Unused", +"DLP automatically created this connection during an initial scan, and it is awaiting full configuration by a user.", +"A configured connection that has not encountered any errors.", +"A configured connection that encountered errors during its last use. It will not be used again until it is set to AVAILABLE. If the resolution requires external action, then a request to set the status to AVAILABLE will mark this connection for use. Otherwise, any changes to the connection properties will automatically mark it as AVAILABLE." +], +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2Container": { "description": "Represents a container that may contain DLP findings. Examples of a container include a file, table, or database record.", "id": "GooglePrivacyDlpV2Container", @@ -5194,6 +5594,17 @@ }, "type": "object" }, +"GooglePrivacyDlpV2CreateConnectionRequest": { +"description": "Request message for CreateConnection.", +"id": "GooglePrivacyDlpV2CreateConnectionRequest", +"properties": { +"connection": { +"$ref": "GooglePrivacyDlpV2Connection", +"description": "Required. The connection resource." +} +}, +"type": "object" +}, "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest": { "description": "Request message for CreateDeidentifyTemplate.", "id": "GooglePrivacyDlpV2CreateDeidentifyTemplateRequest", @@ -5653,6 +6064,69 @@ }, "type": "object" }, +"GooglePrivacyDlpV2DatabaseResourceCollection": { +"description": "Match database resources using regex filters. Examples of database resources are tables, views, and stored procedures.", +"id": "GooglePrivacyDlpV2DatabaseResourceCollection", +"properties": { +"includeRegexes": { +"$ref": "GooglePrivacyDlpV2DatabaseResourceRegexes", +"description": "A collection of regular expressions to match a database resource against." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DatabaseResourceReference": { +"description": "Identifies a single database resource, like a table within a database.", +"id": "GooglePrivacyDlpV2DatabaseResourceReference", +"properties": { +"instance": { +"description": "Required. The instance where this resource is located. For example: Cloud SQL's instance id.", +"type": "string" +}, +"projectId": { +"description": "Required. If within a project-level config, then this must match the config's project id.", +"type": "string" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DatabaseResourceRegex": { +"description": "A pattern to match against one or more database resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.", +"id": "GooglePrivacyDlpV2DatabaseResourceRegex", +"properties": { +"databaseRegex": { +"description": "Regex to test the database name against. If empty, all databases match.", +"type": "string" +}, +"databaseResourceNameRegex": { +"description": "Regex to test the database resource's name against. An example of a database resource name is a table's name. Other database resource names like view names could be included in the future. If empty, all database resources match.", +"type": "string" +}, +"instanceRegex": { +"description": "Regex to test the instance name against. If empty, all instances match.", +"type": "string" +}, +"projectIdRegex": { +"description": "For organizations, if unset, will match all projects. Has no effect for Data Profile configurations created within a project.", +"type": "string" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DatabaseResourceRegexes": { +"description": "A collection of regular expressions to determine what database resources to match against.", +"id": "GooglePrivacyDlpV2DatabaseResourceRegexes", +"properties": { +"patterns": { +"description": "A group of regular expression patterns to match against one or more database resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB.", +"items": { +"$ref": "GooglePrivacyDlpV2DatabaseResourceRegex" +}, +"type": "array" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2DatastoreKey": { "description": "Record key for a finding in Cloud Datastore.", "id": "GooglePrivacyDlpV2DatastoreKey", @@ -6114,6 +6588,95 @@ }, "type": "object" }, +"GooglePrivacyDlpV2DiscoveryCloudSqlConditions": { +"description": "Requirements that must be true before a table is profiled for the first time.", +"id": "GooglePrivacyDlpV2DiscoveryCloudSqlConditions", +"properties": { +"databaseEngines": { +"description": "Optional. Database engines that should be profiled. Optional. Defaults to ALL_SUPPORTED_DATABASE_ENGINES if unspecified.", +"items": { +"enum": [ +"DATABASE_ENGINE_UNSPECIFIED", +"ALL_SUPPORTED_DATABASE_ENGINES", +"MYSQL", +"POSTGRES" +], +"enumDescriptions": [ +"Unused.", +"Include all supported database engines.", +"MySql database.", +"PostGres database." +], +"type": "string" +}, +"type": "array" +}, +"types": { +"description": "Data profiles will only be generated for the database resource types specified in this field. If not specified, defaults to [DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES].", +"items": { +"enum": [ +"DATABASE_RESOURCE_TYPE_UNSPECIFIED", +"DATABASE_RESOURCE_TYPE_ALL_SUPPORTED_TYPES", +"DATABASE_RESOURCE_TYPE_TABLE" +], +"enumDescriptions": [ +"Unused.", +"Includes database resource types that become supported at a later time.", +"Tables." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DiscoveryCloudSqlFilter": { +"description": "Determines what tables will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID, location, instance, database, and database resource name.", +"id": "GooglePrivacyDlpV2DiscoveryCloudSqlFilter", +"properties": { +"collection": { +"$ref": "GooglePrivacyDlpV2DatabaseResourceCollection", +"description": "A specific set of database resources for this filter to apply to." +}, +"databaseResourceReference": { +"$ref": "GooglePrivacyDlpV2DatabaseResourceReference", +"description": "The database resource to scan. Targets including this can only include one target (the target with this database resource reference)." +}, +"others": { +"$ref": "GooglePrivacyDlpV2AllOtherDatabaseResources", +"description": "Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence": { +"description": "How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity.", +"id": "GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence", +"properties": { +"refreshFrequency": { +"description": "Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changes. 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" +}, +"schemaModifiedCadence": { +"$ref": "GooglePrivacyDlpV2SchemaModifiedCadence", +"description": "When to reprofile if the schema has changed." +} +}, +"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", @@ -6311,6 +6874,10 @@ "bigQueryTarget": { "$ref": "GooglePrivacyDlpV2BigQueryDiscoveryTarget", "description": "BigQuery target for Discovery. The first target to match a table will be the one applied." +}, +"cloudSqlTarget": { +"$ref": "GooglePrivacyDlpV2CloudSqlDiscoveryTarget", +"description": "Cloud SQL target for Discovery. The first target to match a table will be the one applied." } }, "type": "object" @@ -7533,7 +8100,7 @@ "type": "object" }, "GooglePrivacyDlpV2JobTrigger": { -"description": "Contains a configuration to make dlp api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.", +"description": "Contains a configuration to make api calls on a repeating basis. See https://cloud.google.com/sensitive-data-protection/docs/concepts-job-triggers to learn more.", "id": "GooglePrivacyDlpV2JobTrigger", "properties": { "createTime": { @@ -8010,6 +8577,24 @@ }, "type": "object" }, +"GooglePrivacyDlpV2ListConnectionsResponse": { +"description": "Response message for ListConnections.", +"id": "GooglePrivacyDlpV2ListConnectionsResponse", +"properties": { +"connections": { +"description": "List of connections.", +"items": { +"$ref": "GooglePrivacyDlpV2Connection" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results. An empty value means there are no more results.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse": { "description": "Response message for ListDeidentifyTemplates.", "id": "GooglePrivacyDlpV2ListDeidentifyTemplatesResponse", @@ -9130,6 +9715,79 @@ }, "type": "object" }, +"GooglePrivacyDlpV2SchemaModifiedCadence": { +"description": "How frequency to modify the profile when the table's schema is modified.", +"id": "GooglePrivacyDlpV2SchemaModifiedCadence", +"properties": { +"frequency": { +"description": "Frequency to regenerate data profiles when the schema is modified. Defaults to monthly.", +"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" +}, +"types": { +"description": "The types of schema modifications to consider. Defaults to NEW_COLUMNS.", +"items": { +"enum": [ +"SQL_SCHEMA_MODIFICATION_UNSPECIFIED", +"NEW_COLUMNS", +"REMOVED_COLUMNS" +], +"enumDescriptions": [ +"Unused.", +"New columns has appeared.", +"Columns have been removed from the table." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2SearchConnectionsResponse": { +"description": "Response message for SearchConnections.", +"id": "GooglePrivacyDlpV2SearchConnectionsResponse", +"properties": { +"connections": { +"description": "List of connections that match the search query. Note that only a subset of the fields will be populated, and only \"name\" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.", +"items": { +"$ref": "GooglePrivacyDlpV2Connection" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results. An empty value means there are no more results.", +"type": "string" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2SecretManagerCredential": { +"description": "A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing).", +"id": "GooglePrivacyDlpV2SecretManagerCredential", +"properties": { +"passwordSecretVersionName": { +"description": "Required. The name of the Secret Manager resource that stores the password, in the form \"projects/project-id/secrets/secret-name/versions/version\".", +"type": "string" +}, +"username": { +"description": "Required. The username.", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2SelectedInfoTypes": { "description": "Apply transformation to the selected info_types.", "id": "GooglePrivacyDlpV2SelectedInfoTypes", @@ -9980,6 +10638,22 @@ }, "type": "object" }, +"GooglePrivacyDlpV2UpdateConnectionRequest": { +"description": "Request message for UpdateConnection.", +"id": "GooglePrivacyDlpV2UpdateConnectionRequest", +"properties": { +"connection": { +"$ref": "GooglePrivacyDlpV2Connection", +"description": "Required. The connection with new values for the relevant fields." +}, +"updateMask": { +"description": "Optional. Mask to control which fields get updated.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest": { "description": "Request message for UpdateDeidentifyTemplate.", "id": "GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index 57cc2f710e8..cd42aa08c64 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1042,7 +1042,7 @@ } } }, -"revision": "20240325", +"revision": "20240328", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4394,11 +4394,11 @@ true "type": "string" }, "name": { -"description": "The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", +"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", "type": "string" }, "state": { -"description": "The state of the processor version.", +"description": "Output only. The state of the processor version.", "enum": [ "STATE_UNSPECIFIED", "DEPLOYED", @@ -4421,6 +4421,7 @@ true "The processor version failed and is in an indeterminate state.", "The processor version is being imported." ], +"readOnly": true, "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index 7cc2604cd1e..89040a74a3f 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, -"revision": "20240325", +"revision": "20240328", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 4296cf7ab9d..a2f212ec47d 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1284,7 +1284,7 @@ } } }, -"revision": "20240325", +"revision": "20240328", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -8414,11 +8414,11 @@ true "type": "string" }, "name": { -"description": "The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", +"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", "type": "string" }, "state": { -"description": "The state of the processor version.", +"description": "Output only. The state of the processor version.", "enum": [ "STATE_UNSPECIFIED", "DEPLOYED", @@ -8441,6 +8441,7 @@ true "The processor version failed and is in an indeterminate state.", "The processor version is being imported." ], +"readOnly": true, "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index c43f807f067..7a17fb58711 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, -"revision": "20240401", +"revision": "20240408", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json index 719be545395..5525bf20415 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json @@ -319,7 +319,7 @@ } } }, -"revision": "20240320", +"revision": "20240326", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "ChannelGrouping": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 8f289da52a6..3428f1442c1 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -3842,7 +3842,7 @@ } } }, -"revision": "20240327", +"revision": "20240402", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 2bbefa90fb9..18dc0b2bfe1 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2503,7 +2503,7 @@ } } }, -"revision": "20240327", +"revision": "20240402", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 244150345df..20280676d6a 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2.json b/googleapiclient/discovery_cache/documents/drivelabels.v2.json index 2a476cc3935..0a9032afcb4 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2.json @@ -1032,7 +1032,7 @@ } } }, -"revision": "20240327", +"revision": "20240403", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2BadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json index 95c7a22e179..36877767b5e 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json @@ -1032,7 +1032,7 @@ } } }, -"revision": "20240327", +"revision": "20240403", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2betaBadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index 71f5ec1f8c7..ae9a24b365e 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { diff --git a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json index 968046fd8dd..e8da5506fd4 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -344,7 +344,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index 251efae79d7..361d8e163bb 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index 6e8802e4f0e..985f4816026 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240331", +"revision": "20240404", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json index 2ebe799e8ff..33563fe2cda 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1.json @@ -1343,7 +1343,7 @@ } } }, -"revision": "20240322", +"revision": "20240401", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json index d4796370e36..bdb13697f33 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseappcheck.v1beta.json @@ -1823,7 +1823,7 @@ } } }, -"revision": "20240322", +"revision": "20240401", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index 49cb6f6500a..8750ea20595 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -941,7 +941,7 @@ } } }, -"revision": "20240329", +"revision": "20240405", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 3c816aaa65b..00648085ae4 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,7 +585,7 @@ } } }, -"revision": "20240329", +"revision": "20240405", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index cf59eea4ac2..3c6205001e2 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -351,7 +351,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://firebasedatabase.googleapis.com/", "schemas": { "DatabaseInstance": { diff --git a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json index ed31b5e7172..4afa51b16fd 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index 17e6fffe28e..5240df5cb51 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -269,7 +269,7 @@ } } }, -"revision": "20240331", +"revision": "20240403", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index c93815998ca..fa84fc04822 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -2422,7 +2422,7 @@ } } }, -"revision": "20240331", +"revision": "20240403", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index e5969c81759..e58cb2922d3 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, -"revision": "20240327", +"revision": "20240405", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json index a412c3c24b5..34049c886ba 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, -"revision": "20240327", +"revision": "20240405", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json new file mode 100644 index 00000000000..86750556008 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -0,0 +1,1156 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://firebaseml.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Firebase ML", +"description": "Access custom machine learning models hosted via Firebase ML.", +"discoveryVersion": "v1", +"documentationLink": "https://firebase.google.com", +"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": "firebaseml:v2beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://firebaseml.mtls.googleapis.com/", +"name": "firebaseml", +"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": { +"projects": { +"resources": { +"locations": { +"resources": { +"publishers": { +"resources": { +"models": { +"methods": { +"countTokens": { +"description": "Perform a token counting.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens", +"httpMethod": "POST", +"id": "firebaseml.projects.locations.publishers.models.countTokens", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+endpoint}:countTokens", +"request": { +"$ref": "CountTokensRequest" +}, +"response": { +"$ref": "CountTokensResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateContent": { +"description": "Generate content with multimodal inputs.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent", +"httpMethod": "POST", +"id": "firebaseml.projects.locations.publishers.models.generateContent", +"parameterOrder": [ +"model" +], +"parameters": { +"model": { +"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+model}:generateContent", +"request": { +"$ref": "GenerateContentRequest" +}, +"response": { +"$ref": "GenerateContentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"streamGenerateContent": { +"description": "Generate content with multimodal inputs with streaming support.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent", +"httpMethod": "POST", +"id": "firebaseml.projects.locations.publishers.models.streamGenerateContent", +"parameterOrder": [ +"model" +], +"parameters": { +"model": { +"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+model}:streamGenerateContent", +"request": { +"$ref": "GenerateContentRequest" +}, +"response": { +"$ref": "GenerateContentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20240405", +"rootUrl": "https://firebaseml.googleapis.com/", +"schemas": { +"Blob": { +"description": "Content blob. It's preferred to send as text directly rather than raw bytes.", +"id": "Blob", +"properties": { +"data": { +"description": "Required. Raw bytes.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The IANA standard MIME type of the source data.", +"type": "string" +} +}, +"type": "object" +}, +"Candidate": { +"description": "A response candidate generated from the model.", +"id": "Candidate", +"properties": { +"citationMetadata": { +"$ref": "CitationMetadata", +"description": "Output only. Source attribution of the generated content.", +"readOnly": true +}, +"content": { +"$ref": "Content", +"description": "Output only. Content parts of the candidate.", +"readOnly": true +}, +"finishMessage": { +"description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", +"readOnly": true, +"type": "string" +}, +"finishReason": { +"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", +"enum": [ +"FINISH_REASON_UNSPECIFIED", +"STOP", +"MAX_TOKENS", +"SAFETY", +"RECITATION", +"OTHER", +"BLOCKLIST", +"PROHIBITED_CONTENT", +"SPII" +], +"enumDescriptions": [ +"The finish reason is unspecified.", +"Natural stop point of the model or provided stop sequence.", +"The maximum number of tokens as specified in the request was reached.", +"The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", +"The token generation was stopped as the response was flagged for unauthorized citations.", +"All other reasons that stopped the token generation", +"The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", +"The token generation was stopped as the response was flagged for the prohibited contents.", +"The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents." +], +"readOnly": true, +"type": "string" +}, +"groundingMetadata": { +"$ref": "GroundingMetadata", +"description": "Output only. Metadata specifies sources used to ground generated content.", +"readOnly": true +}, +"index": { +"description": "Output only. Index of the candidate.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"safetyRatings": { +"description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", +"items": { +"$ref": "SafetyRating" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"Citation": { +"description": "Source attributions for content.", +"id": "Citation", +"properties": { +"endIndex": { +"description": "Output only. End index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"license": { +"description": "Output only. License of the attribution.", +"readOnly": true, +"type": "string" +}, +"publicationDate": { +"$ref": "Date", +"description": "Output only. Publication date of the attribution.", +"readOnly": true +}, +"startIndex": { +"description": "Output only. Start index into the content.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. Url reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CitationMetadata": { +"description": "A collection of source attributions for a piece of content.", +"id": "CitationMetadata", +"properties": { +"citations": { +"description": "Output only. List of citations.", +"items": { +"$ref": "Citation" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"Content": { +"description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.", +"id": "Content", +"properties": { +"parts": { +"description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", +"items": { +"$ref": "Part" +}, +"type": "array" +}, +"role": { +"description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.", +"type": "string" +} +}, +"type": "object" +}, +"CountTokensRequest": { +"description": "Request message for PredictionService.CountTokens.", +"id": "CountTokensRequest", +"properties": { +"contents": { +"description": "Required. Input content.", +"items": { +"$ref": "Content" +}, +"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.", +"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/*`", +"type": "string" +} +}, +"type": "object" +}, +"CountTokensResponse": { +"description": "Response message for PredictionService.CountTokens.", +"id": "CountTokensResponse", +"properties": { +"totalBillableCharacters": { +"description": "The total number of billable characters counted across all instances from the request.", +"format": "int32", +"type": "integer" +}, +"totalTokens": { +"description": "The total number of tokens counted across all instances from the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"FileData": { +"description": "URI based data.", +"id": "FileData", +"properties": { +"fileUri": { +"description": "Required. URI.", +"type": "string" +}, +"mimeType": { +"description": "Required. The IANA standard MIME type of the source data.", +"type": "string" +} +}, +"type": "object" +}, +"FunctionCall": { +"description": "A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.", +"id": "FunctionCall", +"properties": { +"args": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.", +"type": "object" +}, +"name": { +"description": "Required. The name of the function to call. Matches [FunctionDeclaration.name].", +"type": "string" +} +}, +"type": "object" +}, +"FunctionCallingConfig": { +"description": "Function calling config.", +"id": "FunctionCallingConfig", +"properties": { +"allowedFunctionNames": { +"description": "Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.", +"items": { +"type": "string" +}, +"type": "array" +}, +"mode": { +"description": "Optional. Function calling mode.", +"enum": [ +"MODE_UNSPECIFIED", +"AUTO", +"ANY", +"NONE" +], +"enumDescriptions": [ +"Unspecified function calling mode. This value should not be used.", +"Default model behavior, model decides to predict either a function call or a natural language repspose.", +"Model is constrained to always predicting a function call only. If \"allowed_function_names\" are set, the predicted function call will be limited to any one of \"allowed_function_names\", else the predicted function call will be any one of the provided \"function_declarations\".", +"Model will not predict any function call. Model behavior is same as when not passing any function declarations." +], +"type": "string" +} +}, +"type": "object" +}, +"FunctionDeclaration": { +"description": "Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.", +"id": "FunctionDeclaration", +"properties": { +"description": { +"description": "Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.", +"type": "string" +}, +"name": { +"description": "Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.", +"type": "string" +}, +"parameters": { +"$ref": "Schema", +"description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" +}, +"response": { +"$ref": "Schema", +"description": "Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function." +} +}, +"type": "object" +}, +"FunctionResponse": { +"description": "The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction.", +"id": "FunctionResponse", +"properties": { +"name": { +"description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Required. The function response in JSON object format.", +"type": "object" +} +}, +"type": "object" +}, +"GenerateContentRequest": { +"description": "Request message for [PredictionService.GenerateContent].", +"id": "GenerateContentRequest", +"properties": { +"contents": { +"description": "Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.", +"items": { +"$ref": "Content" +}, +"type": "array" +}, +"generationConfig": { +"$ref": "GenerationConfig", +"description": "Optional. Generation config." +}, +"safetySettings": { +"description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", +"items": { +"$ref": "SafetySetting" +}, +"type": "array" +}, +"systemInstruction": { +"$ref": "Content", +"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." +}, +"toolConfig": { +"$ref": "ToolConfig", +"description": "Optional. Tool config. This config is shared for all tools provided in the request." +}, +"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": "Tool" +}, +"type": "array" +} +}, +"type": "object" +}, +"GenerateContentResponse": { +"description": "Response message for [PredictionService.GenerateContent].", +"id": "GenerateContentResponse", +"properties": { +"candidates": { +"description": "Output only. Generated candidates.", +"items": { +"$ref": "Candidate" +}, +"readOnly": true, +"type": "array" +}, +"promptFeedback": { +"$ref": "PromptFeedback", +"description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.", +"readOnly": true +}, +"usageMetadata": { +"$ref": "UsageMetadata", +"description": "Usage metadata about the response(s)." +} +}, +"type": "object" +}, +"GenerationConfig": { +"description": "Generation config.", +"id": "GenerationConfig", +"properties": { +"candidateCount": { +"description": "Optional. Number of candidates to generate.", +"format": "int32", +"type": "integer" +}, +"frequencyPenalty": { +"description": "Optional. Frequency penalties.", +"format": "float", +"type": "number" +}, +"maxOutputTokens": { +"description": "Optional. The maximum number of output tokens to generate per message.", +"format": "int32", +"type": "integer" +}, +"presencePenalty": { +"description": "Optional. Positive penalties.", +"format": "float", +"type": "number" +}, +"responseMimeType": { +"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", +"type": "string" +}, +"stopSequences": { +"description": "Optional. Stop sequences.", +"items": { +"type": "string" +}, +"type": "array" +}, +"temperature": { +"description": "Optional. Controls the randomness of predictions.", +"format": "float", +"type": "number" +}, +"topK": { +"description": "Optional. If specified, top-k sampling will be used.", +"format": "float", +"type": "number" +}, +"topP": { +"description": "Optional. If specified, nucleus sampling will be used.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GroundingMetadata": { +"description": "Metadata returned to client when grounding is enabled.", +"id": "GroundingMetadata", +"properties": { +"retrievalQueries": { +"description": "Optional. Queries executed by the retrieval tools.", +"items": { +"type": "string" +}, +"type": "array" +}, +"webSearchQueries": { +"description": "Optional. Web search queries for the following-up web search.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ModelOperationMetadata": { +"description": "This is returned in the longrunning operations for create/update.", +"id": "ModelOperationMetadata", +"properties": { +"basicOperationStatus": { +"enum": [ +"BASIC_OPERATION_STATUS_UNSPECIFIED", +"BASIC_OPERATION_STATUS_UPLOADING", +"BASIC_OPERATION_STATUS_VERIFYING" +], +"enumDescriptions": [ +"The status is unspecified", +"The model file is being uploaded", +"The model file is being verified" +], +"type": "string" +}, +"name": { +"description": "The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}`", +"type": "string" +} +}, +"type": "object" +}, +"Part": { +"description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", +"id": "Part", +"properties": { +"fileData": { +"$ref": "FileData", +"description": "Optional. URI based data." +}, +"functionCall": { +"$ref": "FunctionCall", +"description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values." +}, +"functionResponse": { +"$ref": "FunctionResponse", +"description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model." +}, +"inlineData": { +"$ref": "Blob", +"description": "Optional. Inlined bytes data." +}, +"text": { +"description": "Optional. Text part (can be code).", +"type": "string" +}, +"videoMetadata": { +"$ref": "VideoMetadata", +"description": "Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data." +} +}, +"type": "object" +}, +"PromptFeedback": { +"description": "Content filter results for a prompt sent in the request.", +"id": "PromptFeedback", +"properties": { +"blockReason": { +"description": "Output only. Blocked reason.", +"enum": [ +"BLOCKED_REASON_UNSPECIFIED", +"SAFETY", +"OTHER", +"BLOCKLIST", +"PROHIBITED_CONTENT" +], +"enumDescriptions": [ +"Unspecified blocked reason.", +"Candidates blocked due to safety.", +"Candidates blocked due to other reason.", +"Candidates blocked due to the terms which are included from the terminology blocklist.", +"Candidates blocked due to prohibited content." +], +"readOnly": true, +"type": "string" +}, +"blockReasonMessage": { +"description": "Output only. A readable block reason message.", +"readOnly": true, +"type": "string" +}, +"safetyRatings": { +"description": "Output only. Safety ratings.", +"items": { +"$ref": "SafetyRating" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"Retrieval": { +"description": "Defines a retrieval tool that model can call to access external knowledge.", +"id": "Retrieval", +"properties": { +"disableAttribution": { +"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"type": "boolean" +}, +"vertexAiSearch": { +"$ref": "VertexAISearch", +"description": "Set to use data source powered by Vertex AI Search." +}, +"vertexRagStore": { +"$ref": "VertexRagStore", +"description": "Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService." +} +}, +"type": "object" +}, +"SafetyRating": { +"description": "Safety rating corresponding to the generated content.", +"id": "SafetyRating", +"properties": { +"blocked": { +"description": "Output only. Indicates whether the content was filtered out because of this rating.", +"readOnly": true, +"type": "boolean" +}, +"category": { +"description": "Output only. Harm category.", +"enum": [ +"HARM_CATEGORY_UNSPECIFIED", +"HARM_CATEGORY_HATE_SPEECH", +"HARM_CATEGORY_DANGEROUS_CONTENT", +"HARM_CATEGORY_HARASSMENT", +"HARM_CATEGORY_SEXUALLY_EXPLICIT" +], +"enumDescriptions": [ +"The harm category is unspecified.", +"The harm category is hate speech.", +"The harm category is dangerous content.", +"The harm category is harassment.", +"The harm category is sexually explicit content." +], +"readOnly": true, +"type": "string" +}, +"probability": { +"description": "Output only. Harm probability levels in the content.", +"enum": [ +"HARM_PROBABILITY_UNSPECIFIED", +"NEGLIGIBLE", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Harm probability unspecified.", +"Negligible level of harm.", +"Low level of harm.", +"Medium level of harm.", +"High level of harm." +], +"readOnly": true, +"type": "string" +}, +"probabilityScore": { +"description": "Output only. Harm probability score.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"severity": { +"description": "Output only. Harm severity levels in the content.", +"enum": [ +"HARM_SEVERITY_UNSPECIFIED", +"HARM_SEVERITY_NEGLIGIBLE", +"HARM_SEVERITY_LOW", +"HARM_SEVERITY_MEDIUM", +"HARM_SEVERITY_HIGH" +], +"enumDescriptions": [ +"Harm severity unspecified.", +"Negligible level of harm severity.", +"Low level of harm severity.", +"Medium level of harm severity.", +"High level of harm severity." +], +"readOnly": true, +"type": "string" +}, +"severityScore": { +"description": "Output only. Harm severity score.", +"format": "float", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"SafetySetting": { +"description": "Safety settings.", +"id": "SafetySetting", +"properties": { +"category": { +"description": "Required. Harm category.", +"enum": [ +"HARM_CATEGORY_UNSPECIFIED", +"HARM_CATEGORY_HATE_SPEECH", +"HARM_CATEGORY_DANGEROUS_CONTENT", +"HARM_CATEGORY_HARASSMENT", +"HARM_CATEGORY_SEXUALLY_EXPLICIT" +], +"enumDescriptions": [ +"The harm category is unspecified.", +"The harm category is hate speech.", +"The harm category is dangerous content.", +"The harm category is harassment.", +"The harm category is sexually explicit content." +], +"type": "string" +}, +"method": { +"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", +"enum": [ +"HARM_BLOCK_METHOD_UNSPECIFIED", +"SEVERITY", +"PROBABILITY" +], +"enumDescriptions": [ +"The harm block method is unspecified.", +"The harm block method uses both probability and severity scores.", +"The harm block method uses the probability score." +], +"type": "string" +}, +"threshold": { +"description": "Required. The harm block threshold.", +"enum": [ +"HARM_BLOCK_THRESHOLD_UNSPECIFIED", +"BLOCK_LOW_AND_ABOVE", +"BLOCK_MEDIUM_AND_ABOVE", +"BLOCK_ONLY_HIGH", +"BLOCK_NONE" +], +"enumDescriptions": [ +"Unspecified harm block threshold.", +"Block low threshold and above (i.e. block more).", +"Block medium threshold and above.", +"Block only high threshold (i.e. block less).", +"Block none." +], +"type": "string" +} +}, +"type": "object" +}, +"Schema": { +"description": "Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed.", +"id": "Schema", +"properties": { +"default": { +"description": "Optional. Default value of the data.", +"type": "any" +}, +"description": { +"description": "Optional. The description of the data.", +"type": "string" +}, +"enum": { +"description": "Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]}", +"items": { +"type": "string" +}, +"type": "array" +}, +"example": { +"description": "Optional. Example of the object. Will only populated when the object is the root.", +"type": "any" +}, +"format": { +"description": "Optional. The format of the data. Supported formats: for NUMBER type: \"float\", \"double\" for INTEGER type: \"int32\", \"int64\" for STRING type: \"email\", \"byte\", etc", +"type": "string" +}, +"items": { +"$ref": "Schema", +"description": "Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY." +}, +"maxItems": { +"description": "Optional. Maximum number of the elements for Type.ARRAY.", +"format": "int64", +"type": "string" +}, +"maxLength": { +"description": "Optional. Maximum length of the Type.STRING", +"format": "int64", +"type": "string" +}, +"maxProperties": { +"description": "Optional. Maximum number of the properties for Type.OBJECT.", +"format": "int64", +"type": "string" +}, +"maximum": { +"description": "Optional. Maximum value of the Type.INTEGER and Type.NUMBER", +"format": "double", +"type": "number" +}, +"minItems": { +"description": "Optional. Minimum number of the elements for Type.ARRAY.", +"format": "int64", +"type": "string" +}, +"minLength": { +"description": "Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING", +"format": "int64", +"type": "string" +}, +"minProperties": { +"description": "Optional. Minimum number of the properties for Type.OBJECT.", +"format": "int64", +"type": "string" +}, +"minimum": { +"description": "Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER", +"format": "double", +"type": "number" +}, +"nullable": { +"description": "Optional. Indicates if the value may be null.", +"type": "boolean" +}, +"pattern": { +"description": "Optional. Pattern of the Type.STRING to restrict a string to a regular expression.", +"type": "string" +}, +"properties": { +"additionalProperties": { +"$ref": "Schema" +}, +"description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", +"type": "object" +}, +"required": { +"description": "Optional. Required properties of Type.OBJECT.", +"items": { +"type": "string" +}, +"type": "array" +}, +"title": { +"description": "Optional. The title of the Schema.", +"type": "string" +}, +"type": { +"description": "Optional. The type of the data.", +"enum": [ +"TYPE_UNSPECIFIED", +"STRING", +"NUMBER", +"INTEGER", +"BOOLEAN", +"ARRAY", +"OBJECT" +], +"enumDescriptions": [ +"Not specified, should not be used.", +"OpenAPI string type", +"OpenAPI number type", +"OpenAPI integer type", +"OpenAPI boolean type", +"OpenAPI array type", +"OpenAPI object type" +], +"type": "string" +} +}, +"type": "object" +}, +"Tool": { +"description": "Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).", +"id": "Tool", +"properties": { +"functionDeclarations": { +"description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.", +"items": { +"$ref": "FunctionDeclaration" +}, +"type": "array" +}, +"retrieval": { +"$ref": "Retrieval", +"description": "Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation." +} +}, +"type": "object" +}, +"ToolConfig": { +"description": "Tool config. This config is shared for all tools provided in the request.", +"id": "ToolConfig", +"properties": { +"functionCallingConfig": { +"$ref": "FunctionCallingConfig", +"description": "Optional. Function calling config." +} +}, +"type": "object" +}, +"UsageMetadata": { +"description": "Usage metadata about response(s).", +"id": "UsageMetadata", +"properties": { +"candidatesTokenCount": { +"description": "Number of tokens in the response(s).", +"format": "int32", +"type": "integer" +}, +"promptTokenCount": { +"description": "Number of tokens in the request.", +"format": "int32", +"type": "integer" +}, +"totalTokenCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"VertexAISearch": { +"description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation", +"id": "VertexAISearch", +"properties": { +"datastore": { +"description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", +"type": "string" +} +}, +"type": "object" +}, +"VertexRagStore": { +"description": "Retrieve from Vertex RAG Store for grounding.", +"id": "VertexRagStore", +"properties": { +"ragCorpora": { +"description": "Required. Vertex RAG Store corpus resource name: `projects/{project}/locations/{location}/ragCorpora/{ragCorpus}` Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.", +"items": { +"type": "string" +}, +"type": "array" +}, +"similarityTopK": { +"description": "Optional. Number of top k results to return from the selected corpora.", +"format": "int32", +"type": "integer" +}, +"vectorDistanceThreshold": { +"description": "Optional. Only return results with vector distance smaller than the threshold.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"VideoMetadata": { +"description": "Metadata describes the input video content.", +"id": "VideoMetadata", +"properties": { +"endOffset": { +"description": "Optional. The end offset of the video.", +"format": "google-duration", +"type": "string" +}, +"startOffset": { +"description": "Optional. The start offset of the video.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Firebase ML API", +"version": "v2beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json index f8b4f54bbf9..57e3a4b437d 100644 --- a/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasestorage.v1beta.json @@ -238,7 +238,7 @@ } } }, -"revision": "20240315", +"revision": "20240402", "rootUrl": "https://firebasestorage.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index 0312cfe2d0a..812b826c6b1 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -832,7 +832,7 @@ } } }, -"revision": "20240326", +"revision": "20240407", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index c5f160c85bb..cfbd5d39278 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20240321", +"revision": "20240326", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/games.v1.json b/googleapiclient/discovery_cache/documents/games.v1.json index 7285b3c516c..8205316be60 100644 --- a/googleapiclient/discovery_cache/documents/games.v1.json +++ b/googleapiclient/discovery_cache/documents/games.v1.json @@ -1354,7 +1354,7 @@ false } } }, -"revision": "20240320", +"revision": "20240408", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { diff --git a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json index 594d1be32bc..a7fbc5ac65b 100644 --- a/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json +++ b/googleapiclient/discovery_cache/documents/gamesConfiguration.v1configuration.json @@ -381,7 +381,7 @@ } } }, -"revision": "20240320", +"revision": "20240408", "rootUrl": "https://gamesconfiguration.googleapis.com/", "schemas": { "AchievementConfiguration": { diff --git a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json index 80c4b7c9c6a..8b120adbc19 100644 --- a/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json +++ b/googleapiclient/discovery_cache/documents/gamesManagement.v1management.json @@ -471,7 +471,7 @@ } } }, -"revision": "20240320", +"revision": "20240408", "rootUrl": "https://gamesmanagement.googleapis.com/", "schemas": { "AchievementResetAllResponse": { diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index c9821227be5..aed00406e94 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -3077,7 +3077,7 @@ } } }, -"revision": "20240325", +"revision": "20240401", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json index 0aee24b328d..776eb956895 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json index a245e051372..6e538fb7799 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json index 7e99d306665..877706f58ce 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240311", +"revision": "20240318", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index e8b68e11bb1..bda3acab13b 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4554,7 +4554,7 @@ } } }, -"revision": "20240312", +"revision": "20240329", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 7b1528ca185..5a1e9010b98 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -5614,7 +5614,7 @@ } } }, -"revision": "20240312", +"revision": "20240329", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/homegraph.v1.json b/googleapiclient/discovery_cache/documents/homegraph.v1.json index 21ec1670ac7..c9927bbef38 100644 --- a/googleapiclient/discovery_cache/documents/homegraph.v1.json +++ b/googleapiclient/discovery_cache/documents/homegraph.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://homegraph.googleapis.com/", "schemas": { "AgentDeviceId": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index 0ae7f2428ad..65aecd0c603 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,7 +226,7 @@ } } }, -"revision": "20240320", +"revision": "20240404", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index 083c588da93..8567c65c667 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, -"revision": "20240326", +"revision": "20240404", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1alpha.json b/googleapiclient/discovery_cache/documents/integrations.v1alpha.json index dd9385392ad..4814ae5395d 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1alpha.json @@ -3299,7 +3299,7 @@ } } }, -"revision": "20240325", +"revision": "20240327", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -7778,6 +7778,9 @@ false "protoDefPath": { "description": "If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be \"enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry\".", "type": "string" +}, +"required": { +"type": "boolean" } }, "type": "object" @@ -9850,10 +9853,19 @@ false "description": "Required. If any integration version is published.", "type": "boolean" }, +"creatorEmail": { +"description": "Output only. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", +"readOnly": true, +"type": "string" +}, "description": { "description": "Optional.", "type": "string" }, +"lastModifierEmail": { +"description": "Required. The last modifier of this integration", +"type": "string" +}, "name": { "description": "Required. The resource name of the integration.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index 6820e8188a3..e154dde0a63 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -246,7 +246,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/googleapiclient/discovery_cache/documents/language.v1beta2.json b/googleapiclient/discovery_cache/documents/language.v1beta2.json index 1d4bc87be9a..6fca3786c26 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -246,7 +246,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/googleapiclient/discovery_cache/documents/language.v2.json b/googleapiclient/discovery_cache/documents/language.v2.json index c92e3e6ea7f..3933e9e3c03 100644 --- a/googleapiclient/discovery_cache/documents/language.v2.json +++ b/googleapiclient/discovery_cache/documents/language.v2.json @@ -208,7 +208,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json index 78e22ad6ad5..60bb42df676 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/googleapiclient/discovery_cache/documents/licensing.v1.json b/googleapiclient/discovery_cache/documents/licensing.v1.json index 88bc3cecf0d..baba185ddb7 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20240329", +"revision": "20240406", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index 820d18fb361..ee96f07d6ae 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://localservices.googleapis.com/", "schemas": { "GoogleAdsHomeservicesLocalservicesV1AccountReport": { diff --git a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json index cc5fad9010c..52144d9db53 100644 --- a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json @@ -235,7 +235,7 @@ } } }, -"revision": "20240401", +"revision": "20240408", "rootUrl": "https://marketingplatformadmin.googleapis.com/", "schemas": { "AnalyticsAccountLink": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 6be1fabdf06..f98a13b859f 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2317,7 +2317,7 @@ } } }, -"revision": "20240321", +"revision": "20240328", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index b19bf0ac1dc..36f8a4434e3 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 979637ee70d..622114be781 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index 5d1448ec583..6b263c06533 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index a8a8f09447a..647d6d029b6 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index 2acd1fdc082..eddd9a03a2d 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json index 38ec8d9c4b0..576074f2684 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -323,7 +323,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinessqanda.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index ca33dc2374f..fab9bb4cf6c 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -237,7 +237,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index ac9f875938b..cce609a130a 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -1063,7 +1063,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index b73f251da0d..335b5866fbd 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -687,7 +687,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index e08022d0cd4..ad90f588b5a 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -689,7 +689,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1.json b/googleapiclient/discovery_cache/documents/oslogin.v1.json index 159ca06d33d..1dc874a2704 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1.json @@ -349,7 +349,7 @@ } } }, -"revision": "20240308", +"revision": "20240326", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json index 4cb03890efe..3d63f9ad167 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -193,7 +193,7 @@ } } }, -"revision": "20240329", +"revision": "20240404", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 740564ad2a4..99fe4d3deba 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -435,7 +435,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -1106,6 +1106,11 @@ }, "type": "array" }, +"purchaseTime": { +"description": "Optional. The timestamp when the user transaction was made with the Partner. Specify for the case of \"bundle with choice\", and it must be before the provision_time (when the user makes a selection).", +"format": "google-datetime", +"type": "string" +}, "redirectUri": { "description": "Output only. The place where partners should redirect the end-user to after creation. This field might also be populated when creation failed. However, Partners should always prepare a default URL to redirect the user in case this field is empty.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index 8a37481149f..310b1ec7be9 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1190,7 +1190,7 @@ } } }, -"revision": "20240325", +"revision": "20240407", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index b61298328d4..0448013c0b8 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -276,7 +276,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -493,7 +493,7 @@ }, "text": { "$ref": "GoogleMapsPlacesV1AutocompletePlacesResponseSuggestionFormattableText", -"description": "The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, TextSearch). `text` is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. They are two different ways to represent a query prediction. Users should not try to parse `structured_format` into `text` or vice versa. May be in mixed languages if the request `input` and `language_code` are in different languages or if part of the query does not have a translation from the local language to `language_code`." +"description": "The predicted text. This text does not represent a Place, but rather a text query that could be used in a search endpoint (for example, Text Search). `text` is recommended for developers who wish to show a single UI element. Developers who wish to show two separate, but related, UI elements may want to use `structured_format` instead. They are two different ways to represent a query prediction. Users should not try to parse `structured_format` into `text` or vice versa. May be in mixed languages if the request `input` and `language_code` are in different languages or if part of the query does not have a translation from the local language to `language_code`." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index 4df8bf0d506..7df933da903 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, -"revision": "20240327", +"revision": "20240407", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index ab402773785..46ca45329d3 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -947,7 +947,7 @@ } } }, -"revision": "20240327", +"revision": "20240401", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 7eddef954d5..5aedf887999 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -947,7 +947,7 @@ } } }, -"revision": "20240327", +"revision": "20240401", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json b/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json index a7ee41090b5..e3c90f7f799 100644 --- a/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240327", +"revision": "20240407", "rootUrl": "https://playgrouping.googleapis.com/", "schemas": { "CreateOrUpdateTagsRequest": { diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 2a139e56fa6..7722f265b8f 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -138,7 +138,7 @@ } } }, -"revision": "20240327", +"revision": "20240407", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index f2bdbf051a1..d8108dc2d98 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -942,7 +942,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index 3e02906cde5..bff38ef405d 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -1078,7 +1078,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index 549e92f181d..09ff3a5bc90 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -1078,7 +1078,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json index 21fe99e5741..eb52b5bad59 100644 --- a/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/prod_tt_sasportal.v1alpha1.json @@ -2653,7 +2653,7 @@ } } }, -"revision": "20240331", +"revision": "20240401", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/publicca.v1.json b/googleapiclient/discovery_cache/documents/publicca.v1.json index b4b699715e1..ab69be4520c 100644 --- a/googleapiclient/discovery_cache/documents/publicca.v1.json +++ b/googleapiclient/discovery_cache/documents/publicca.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240325", +"revision": "20240402", "rootUrl": "https://publicca.googleapis.com/", "schemas": { "ExternalAccountKey": { diff --git a/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json b/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json index 2af4af23325..a24c4c8dd2d 100644 --- a/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240325", +"revision": "20240402", "rootUrl": "https://publicca.googleapis.com/", "schemas": { "ExternalAccountKey": { diff --git a/googleapiclient/discovery_cache/documents/publicca.v1beta1.json b/googleapiclient/discovery_cache/documents/publicca.v1beta1.json index c5354fc2e21..d6813d5b185 100644 --- a/googleapiclient/discovery_cache/documents/publicca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/publicca.v1beta1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240325", +"revision": "20240402", "rootUrl": "https://publicca.googleapis.com/", "schemas": { "ExternalAccountKey": { diff --git a/googleapiclient/discovery_cache/documents/pubsublite.v1.json b/googleapiclient/discovery_cache/documents/pubsublite.v1.json index d1d8598f495..65a0d927e3b 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, -"revision": "20240322", +"revision": "20240329", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index 12f764945ac..34a7d97f1be 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240325", +"revision": "20240403", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 37a2da57719..c9d886cf097 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, -"revision": "20240327", +"revision": "20240408", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { diff --git a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json index 6c5264121ba..efddc8472d6 100644 --- a/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommendationengine.v1beta1.json @@ -841,7 +841,7 @@ } } }, -"revision": "20240321", +"revision": "20240401", "rootUrl": "https://recommendationengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index c9fdb6e7b2a..dcdf97d4e22 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -651,7 +651,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index 31a19187db5..bcc3506bbff 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -499,7 +499,7 @@ } } }, -"revision": "20240331", +"revision": "20240403", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index 5d13a93db5d..f8d5a0c25b8 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v5.json b/googleapiclient/discovery_cache/documents/safebrowsing.v5.json index cae381004c1..7c019cb412e 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v5.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v5.json @@ -121,7 +121,7 @@ } } }, -"revision": "20240324", +"revision": "20240331", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleSecuritySafebrowsingV5FullHash": { diff --git a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json index 0391db3387b..4227c9b35a3 100644 --- a/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json @@ -2652,7 +2652,7 @@ } } }, -"revision": "20240325", +"revision": "20240401", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index 73bcfdf9a1f..fde6f0b0410 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -891,7 +891,7 @@ } } }, -"revision": "20240317", +"revision": "20240331", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 57eb0c25f79..16baf0fe03f 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20240330", +"revision": "20240407", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index da304757afa..9d68d175075 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 557b89b2c95..7022285c281 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index c55048df3be..fcb0321c4e9 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json index 1836c5fe5e7..6c62899ffb8 100644 --- a/googleapiclient/discovery_cache/documents/solar.v1.json +++ b/googleapiclient/discovery_cache/documents/solar.v1.json @@ -262,7 +262,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index d576f3b12f8..be53d0809ad 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -524,7 +524,7 @@ } } }, -"revision": "20240321", +"revision": "20240405", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index b774b80f3bd..14d30ce7202 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, -"revision": "20240321", +"revision": "20240405", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index d4524ccf602..9d818e799bd 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240324", +"revision": "20240404", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 74c55b09458..fc4894c7dbe 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240324", +"revision": "20240404", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 622e867faaf..fc581087494 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -33,7 +33,7 @@ "location": "me-central2" } ], -"etag": "\"34373838303034303336343236373630313831\"", +"etag": "\"363538353332373134383231383131323930\"", "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" @@ -4043,7 +4043,7 @@ } } }, -"revision": "20240327", +"revision": "20240331", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index ed1286dfa16..54876bd5131 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -534,7 +534,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 4fc9807d782..9a437f243ee 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, -"revision": "20240327", +"revision": "20240408", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index d78ba22a892..2b4f7cd19c7 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3890,7 +3890,7 @@ } } }, -"revision": "20240327", +"revision": "20240408", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index 0874b1e37a0..ba59ffb87ec 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -566,7 +566,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "Task": { diff --git a/googleapiclient/discovery_cache/documents/testing.v1.json b/googleapiclient/discovery_cache/documents/testing.v1.json index da57e279a55..5b3f68e4614 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240325", +"revision": "20240405", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index 22cefdc7a4f..4a060bcd1df 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, -"revision": "20240401", +"revision": "20240404", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json index 6daa49d3238..22ba537d08a 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240312", +"revision": "20240322", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { @@ -1192,13 +1192,17 @@ "type": "object" }, "StringMatcher": { -"description": "Specifies the way to match a string. [#next-free-field: 8]", +"description": "Specifies the way to match a string. [#next-free-field: 9]", "id": "StringMatcher", "properties": { "contains": { "description": "The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``", "type": "string" }, +"custom": { +"$ref": "TypedExtensionConfig", +"description": "Use an extension as the matcher type. [#extension-category: envoy.string_matcher]" +}, "exact": { "description": "The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.", "type": "string" @@ -1240,6 +1244,25 @@ }, "type": "object" }, +"TypedExtensionConfig": { +"description": "Message type for extension configuration.", +"id": "TypedExtensionConfig", +"properties": { +"name": { +"description": "The name of an extension. This is not used to select the extension, instead it serves the role of an opaque identifier.", +"type": "string" +}, +"typedConfig": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The typed config for the extension. The type URL will be used to identify the extension. In the case that the type URL is *xds.type.v3.TypedStruct* (or, for historical reasons, *udpa.type.v1.TypedStruct*), the inner type URL of *TypedStruct* will be utilized. See the :ref:`extension configuration overview ` for further details.", +"type": "object" +} +}, +"type": "object" +}, "UpdateFailureState": { "id": "UpdateFailureState", "properties": { diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 7f9b7b056a0..99bad2e1f91 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240330", +"revision": "20240407", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index e27836e22d2..28688eff40b 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1203,7 +1203,7 @@ } } }, -"revision": "20240315", +"revision": "20240401", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json index e4206b62768..5c039472a90 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240319", +"revision": "20240402", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json index 354dbd85b65..73ff6e74edc 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240319", +"revision": "20240402", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { @@ -329,6 +329,10 @@ }, "type": "array" }, +"profileEnrollmentDomain": { +"description": "Enrollment domain of the customer which is currently managing the profile.", +"type": "string" +}, "realtimeUrlCheckMode": { "description": "Whether Enterprise-grade (i.e. custom) unsafe URL scanning is enabled or not. This setting may be controlled by an enterprise policy: https://chromeenterprise.google/policies/#EnterpriseRealTimeUrlCheckMode", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index 4c157e397b8..247bb3762a2 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, -"revision": "20240331", +"revision": "20240407", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index ba81288a771..ce4bea18a38 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240401", +"revision": "20240408", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { diff --git a/googleapiclient/discovery_cache/documents/webfonts.v1.json b/googleapiclient/discovery_cache/documents/webfonts.v1.json index 08e48a176ef..e09fdd3deb5 100644 --- a/googleapiclient/discovery_cache/documents/webfonts.v1.json +++ b/googleapiclient/discovery_cache/documents/webfonts.v1.json @@ -161,7 +161,7 @@ } } }, -"revision": "20240327", +"revision": "20240403", "rootUrl": "https://webfonts.googleapis.com/", "schemas": { "Axis": { diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 9a4a157adc4..913707955a1 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -353,7 +353,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Required. The field to update. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to-live (TTL) or duration of the subscription.", +"description": "Optional. The field to update. If omitted, updates any fields included in the request. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to-live (TTL) or duration of the subscription. To fully replace the subscription (the equivalent of `PUT`), use `*`. Any omitted fields are updated with empty values.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -424,7 +424,7 @@ } } }, -"revision": "20240326", +"revision": "20240402", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index fd3efc06da1..b7badad3a20 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4037,7 +4037,7 @@ } } }, -"revision": "20240326", +"revision": "20240407", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": {