From a4964d5f17a510d3f8fa34e5e4406184b958d00a Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Tue, 20 Aug 2024 00:32:22 -0700 Subject: [PATCH] chore: Update discovery artifacts (#2466) ## Deleted keys were detected in the following stable discovery artifacts: alloydb v1 https://togithub.com/googleapis/google-api-python-client/commit/bcfe7d1b4490955a16cd0452ec52abba38374c3c backupdr v1 https://togithub.com/googleapis/google-api-python-client/commit/e95ba9b0696cb49e9e327dec818c9ebd110cd1af bigquery v2 https://togithub.com/googleapis/google-api-python-client/commit/fddb5fd1e36a4e4af3df63c7fa97f74e2895edc1 compute v1 https://togithub.com/googleapis/google-api-python-client/commit/0da5dd30efcc6c86cc7349ba2201d3a7fe16b8c3 dialogflow v2 https://togithub.com/googleapis/google-api-python-client/commit/227faa6b5d227ed0287e929f647ced12a0b1e7e2 dialogflow v3 https://togithub.com/googleapis/google-api-python-client/commit/227faa6b5d227ed0287e929f647ced12a0b1e7e2 integrations v1 https://togithub.com/googleapis/google-api-python-client/commit/097eea11af945221753c321798982ce08ae67c37 redis v1 https://togithub.com/googleapis/google-api-python-client/commit/9f48ea3e73f1258526996d01a1cc06d4f53a3e07 vmmigration v1 https://togithub.com/googleapis/google-api-python-client/commit/725dc897f8505f9d8194a60cf727d68269c5b033 ## Deleted keys were detected in the following pre-stable discovery artifacts: alloydb v1alpha https://togithub.com/googleapis/google-api-python-client/commit/bcfe7d1b4490955a16cd0452ec52abba38374c3c alloydb v1beta https://togithub.com/googleapis/google-api-python-client/commit/bcfe7d1b4490955a16cd0452ec52abba38374c3c compute alpha https://togithub.com/googleapis/google-api-python-client/commit/0da5dd30efcc6c86cc7349ba2201d3a7fe16b8c3 compute beta https://togithub.com/googleapis/google-api-python-client/commit/0da5dd30efcc6c86cc7349ba2201d3a7fe16b8c3 dialogflow v2beta1 https://togithub.com/googleapis/google-api-python-client/commit/227faa6b5d227ed0287e929f647ced12a0b1e7e2 dialogflow v3beta1 https://togithub.com/googleapis/google-api-python-client/commit/227faa6b5d227ed0287e929f647ced12a0b1e7e2 redis v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/9f48ea3e73f1258526996d01a1cc06d4f53a3e07 vmmigration v1alpha1 https://togithub.com/googleapis/google-api-python-client/commit/725dc897f8505f9d8194a60cf727d68269c5b033 ## Discovery Artifact Change Summary: feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/016286b9fc61eb568bf0d30877eeb7c5738765f5 feat(alloydb): update the api https://togithub.com/googleapis/google-api-python-client/commit/bcfe7d1b4490955a16cd0452ec52abba38374c3c feat(androidpublisher): update the api https://togithub.com/googleapis/google-api-python-client/commit/b482cb902f4555bb8cbf0932903b275c3defa899 feat(backupdr): update the api https://togithub.com/googleapis/google-api-python-client/commit/e95ba9b0696cb49e9e327dec818c9ebd110cd1af feat(beyondcorp): update the api https://togithub.com/googleapis/google-api-python-client/commit/6c80694b0325c64c792c18227663c700403e7b94 feat(bigquery): update the api https://togithub.com/googleapis/google-api-python-client/commit/fddb5fd1e36a4e4af3df63c7fa97f74e2895edc1 feat(bigtableadmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/4a75f7e8be07d57a44a71a3a9cc7d503c026dff3 feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/0da5dd30efcc6c86cc7349ba2201d3a7fe16b8c3 feat(connectors): update the api https://togithub.com/googleapis/google-api-python-client/commit/9ef64b020a712951d07f0df37b3003baaceac056 feat(container): update the api https://togithub.com/googleapis/google-api-python-client/commit/bbdc26ae8e9337c0032bf333b92df231bb0a0c45 feat(dataflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/955a2eb6cadadc8a5469c68a2b96d708a5753710 feat(datamigration): update the api https://togithub.com/googleapis/google-api-python-client/commit/3ba86616ecfe16e0bf2b6d031fa01045f39ea16c feat(dialogflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/227faa6b5d227ed0287e929f647ced12a0b1e7e2 feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/a8a82673f53e367ef19f3b3b6b92460dfa55cb8b feat(displayvideo): update the api https://togithub.com/googleapis/google-api-python-client/commit/ed3825f216f9615b838b8c0f709fd144d6384238 feat(dlp): update the api https://togithub.com/googleapis/google-api-python-client/commit/df3c8e91103634b28cd6fd5da1a42088ba654fcc feat(documentai): update the api https://togithub.com/googleapis/google-api-python-client/commit/b3a0025c19fb409dea97fda3cef64c913c096072 feat(gkehub): update the api https://togithub.com/googleapis/google-api-python-client/commit/d527515c96d7861d71d506a97c06aa73137639b0 feat(healthcare): update the api https://togithub.com/googleapis/google-api-python-client/commit/0391573439a1cb8f04e67f1fd5fc3074abd9eb36 feat(integrations): update the api https://togithub.com/googleapis/google-api-python-client/commit/097eea11af945221753c321798982ce08ae67c37 feat(manufacturers): update the api https://togithub.com/googleapis/google-api-python-client/commit/043bd6b0b4ce2fbed2b49dc526427d9ecc67078a feat(migrationcenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/e4940f14ed1c7caf4cbaefd747cd6b40d7b433e0 feat(networkconnectivity): update the api https://togithub.com/googleapis/google-api-python-client/commit/6aca7bb3d0f87ce0dc70ba359d847cbf963081f2 feat(networkmanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/997ed8ac23aad4b1fc9fdb9fe2f2cb4ae5916e36 feat(recaptchaenterprise): update the api https://togithub.com/googleapis/google-api-python-client/commit/fc61f5f9b5891c9c9f4635af2d06507a0f2fe2b5 feat(redis): update the api https://togithub.com/googleapis/google-api-python-client/commit/9f48ea3e73f1258526996d01a1cc06d4f53a3e07 feat(run): update the api https://togithub.com/googleapis/google-api-python-client/commit/7d912586990c833dc5f02bc27a74652233c160a2 feat(searchads360): update the api https://togithub.com/googleapis/google-api-python-client/commit/75ebf3109dc315821297c64498488c43f445d097 feat(securitycenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/b698e42e25c5567dab5fbb4d6c7a0082f7ee91ac feat(serviceusage): update the api https://togithub.com/googleapis/google-api-python-client/commit/4f08fef40014d2cd9c7d7d9dd8fc0316c9662fe9 feat(spanner): update the api https://togithub.com/googleapis/google-api-python-client/commit/4ebb5dad76ab8aab198ddcc1ff80e31d2d4f5683 feat(vmmigration): update the api https://togithub.com/googleapis/google-api-python-client/commit/725dc897f8505f9d8194a60cf727d68269c5b033 feat(youtube): update the api https://togithub.com/googleapis/google-api-python-client/commit/a25f063020b73c23e7820103b02ff9261981b330 --- ...r_v1.accessPolicies.servicePerimeters.html | 40 +- ...tform_v1.projects.locations.endpoints.html | 8 +- ...m_v1.projects.locations.featureGroups.html | 12 + ...eStores.featureViews.featureViewSyncs.html | 4 + ...ions.featureOnlineStores.featureViews.html | 8 + ...rojects.locations.featureOnlineStores.html | 8 + ...s.locations.featurestores.entityTypes.html | 10 + ...m_v1.projects.locations.featurestores.html | 8 + .../dyn/aiplatform_v1.projects.locations.html | 24 + ..._v1.projects.locations.indexEndpoints.html | 10 + ...latform_v1.projects.locations.indexes.html | 8 + ...cations.modelDeploymentMonitoringJobs.html | 10 + ....projects.locations.publishers.models.html | 8 +- docs/dyn/aiplatform_v1.publishers.models.html | 5 +- ..._v1beta1.projects.locations.endpoints.html | 8 +- ...eta1.projects.locations.featureGroups.html | 12 + ...eStores.featureViews.featureViewSyncs.html | 4 + ...ions.featureOnlineStores.featureViews.html | 8 + ...rojects.locations.featureOnlineStores.html | 8 + ...s.locations.featurestores.entityTypes.html | 10 + ...eta1.projects.locations.featurestores.html | 8 + ...aiplatform_v1beta1.projects.locations.html | 24 + ...ta1.projects.locations.indexEndpoints.html | 10 + ...rm_v1beta1.projects.locations.indexes.html | 8 + ...cations.modelDeploymentMonitoringJobs.html | 10 + ....projects.locations.publishers.models.html | 8 +- ...rojects.locations.ragCorpora.ragFiles.html | 4 + .../aiplatform_v1beta1.publishers.models.html | 5 +- ...lloydb_v1.projects.locations.clusters.html | 6 + ...projects.locations.clusters.instances.html | 3 + ...b_v1alpha.projects.locations.clusters.html | 84 +++ ...projects.locations.clusters.instances.html | 8 + ...db_v1beta.projects.locations.clusters.html | 36 + ...projects.locations.clusters.instances.html | 8 + ...ublisher_v3.purchases.subscriptionsv2.html | 2 + .../apikeys_v2.projects.locations.keys.html | 8 +- ...projects.locations.repositories.files.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ...projects.locations.repositories.files.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ...projects.locations.repositories.files.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ...ects.locations.backupPlanAssociations.html | 3 - ...pdr_v1.projects.locations.backupPlans.html | 6 - ...global_.securityGateways.applications.html | 241 ++++++ ...ts.locations.global_.securityGateways.html | 265 +------ ...cations.global_.securityGateways.hubs.html | 233 ++++++ ...beyondcorp_v1alpha.projects.locations.html | 5 + ...cations.securityGateways.applications.html | 227 ++++++ ...a.projects.locations.securityGateways.html | 10 + ...jects.locations.securityGateways.hubs.html | 219 ++++++ docs/dyn/bigquery_v2.jobs.html | 170 ++--- docs/dyn/bigquery_v2.tables.html | 140 ++-- ...2.projects.instances.clusters.backups.html | 20 +- docs/dyn/chat_v1.spaces.messages.html | 16 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 24 +- ...nagement_v1.customers.telemetry.users.html | 4 +- ...ions.deliveryPipelines.automationRuns.html | 8 +- ...cations.deliveryPipelines.automations.html | 16 +- ...oudtasks_v2.projects.locations.queues.html | 36 +- ...sks_v2beta2.projects.locations.queues.html | 36 +- ...sks_v2beta3.projects.locations.queues.html | 36 +- docs/dyn/compute_alpha.backendServices.html | 14 +- docs/dyn/compute_alpha.html | 5 - .../compute_alpha.regionBackendServices.html | 12 +- docs/dyn/compute_alpha.vpnTunnels.html | 32 +- docs/dyn/compute_beta.backendServices.html | 14 + docs/dyn/compute_beta.forwardingRules.html | 10 + docs/dyn/compute_beta.futureReservations.html | 5 - .../compute_beta.globalForwardingRules.html | 8 + docs/dyn/compute_beta.machineTypes.html | 3 + .../compute_beta.regionBackendServices.html | 12 + docs/dyn/compute_beta.vpnTunnels.html | 32 +- docs/dyn/compute_v1.futureReservations.html | 5 - docs/dyn/compute_v1.machineTypes.html | 3 + docs/dyn/compute_v1.vpnTunnels.html | 32 +- ...ors_v1.projects.locations.connections.html | 10 + ...cations.providers.connectors.versions.html | 8 + ...tainer_v1.projects.locations.clusters.html | 30 + ...projects.locations.clusters.nodePools.html | 12 + .../container_v1.projects.zones.clusters.html | 30 + ..._v1.projects.zones.clusters.nodePools.html | 12 + ...r_v1beta1.projects.locations.clusters.html | 26 +- ...projects.locations.clusters.nodePools.html | 12 + ...ainer_v1beta1.projects.zones.clusters.html | 26 +- ...ta1.projects.zones.clusters.nodePools.html | 12 + ...dataflow_v1b3.projects.jobs.workItems.html | 2 + ...1b3.projects.locations.jobs.workItems.html | 2 + ...low_v1b3.projects.locations.templates.html | 12 +- .../dyn/dataflow_v1b3.projects.templates.html | 12 +- ...projects.locations.connectionProfiles.html | 56 ++ ...n_v1.projects.locations.migrationJobs.html | 5 + ...jects.locations.migrationJobs.objects.html | 258 +++++++ ...v2.projects.conversations.suggestions.html | 2 +- ...s.locations.conversations.suggestions.html | 2 +- ...low_v2.projects.locations.suggestions.html | 2 +- .../dialogflow_v2.projects.suggestions.html | 2 +- ...beta1.projects.conversations.messages.html | 6 +- ...1.projects.conversations.participants.html | 4 +- ...a1.projects.conversations.suggestions.html | 2 +- ...ects.locations.conversations.messages.html | 6 +- ....locations.conversations.participants.html | 4 +- ...s.locations.conversations.suggestions.html | 2 +- ...2beta1.projects.locations.suggestions.html | 4 +- ...alogflow_v2beta1.projects.suggestions.html | 4 +- ...ocations.agents.environments.sessions.html | 146 ++-- ...ow_v3.projects.locations.agents.flows.html | 72 +- ...projects.locations.agents.flows.pages.html | 144 ++-- ...ns.agents.flows.transitionRouteGroups.html | 24 +- ...v3.projects.locations.agents.sessions.html | 146 ++-- ...3.projects.locations.agents.testCases.html | 400 +++++----- ...ts.locations.agents.testCases.results.html | 52 +- ...ocations.agents.transitionRouteGroups.html | 24 +- ...ojects.locations.agents.conversations.html | 246 +++--- ...ocations.agents.environments.sessions.html | 182 +++-- ...beta1.projects.locations.agents.flows.html | 72 +- ...projects.locations.agents.flows.pages.html | 144 ++-- ...ns.agents.flows.transitionRouteGroups.html | 24 +- ...a1.projects.locations.agents.sessions.html | 182 +++-- ...1.projects.locations.agents.testCases.html | 400 +++++----- ...ts.locations.agents.testCases.results.html | 52 +- ...beta1.projects.locations.agents.tools.html | 24 + ...ocations.agents.transitionRouteGroups.html | 24 +- ...ections.dataStores.branches.documents.html | 10 +- ...tions.collections.dataStores.branches.html | 31 + ...ions.dataStores.completionSuggestions.html | 2 +- ...tions.collections.dataStores.controls.html | 12 +- ...s.collections.dataStores.customModels.html | 120 +++ ...ects.locations.collections.dataStores.html | 80 ++ ...ons.collections.dataStores.userEvents.html | 2 +- ...ocations.collections.engines.controls.html | 12 +- ...cations.dataStores.branches.documents.html | 10 +- ...rojects.locations.dataStores.branches.html | 31 + ...ions.dataStores.completionSuggestions.html | 2 +- ...rojects.locations.dataStores.controls.html | 12 +- ...gine_v1.projects.locations.dataStores.html | 20 + ...jects.locations.dataStores.userEvents.html | 2 +- ...1.projects.locations.groundingConfigs.html | 1 + ...ections.dataStores.branches.documents.html | 10 +- ...tions.collections.dataStores.branches.html | 31 + ...ions.dataStores.completionSuggestions.html | 2 +- ...tions.collections.dataStores.controls.html | 12 +- ...ects.locations.collections.dataStores.html | 20 + ...collections.dataStores.servingConfigs.html | 1 + ...ons.collections.dataStores.userEvents.html | 2 +- ...ocations.collections.engines.controls.html | 12 +- ...ns.collections.engines.servingConfigs.html | 1 + ...cations.dataStores.branches.documents.html | 10 +- ...rojects.locations.dataStores.branches.html | 31 + ...ions.dataStores.completionSuggestions.html | 2 +- ...rojects.locations.dataStores.controls.html | 12 +- ...v1alpha.projects.locations.dataStores.html | 20 + ...s.locations.dataStores.servingConfigs.html | 1 + ...jects.locations.dataStores.userEvents.html | 2 +- ...a.projects.locations.groundingConfigs.html | 1 + ...veryengine_v1alpha.projects.locations.html | 11 +- ...cations.sampleQuerySets.sampleQueries.html | 2 +- ...v1alpha.projects.locations.userStores.html | 91 +++ ...jects.locations.userStores.operations.html | 187 +++++ ...ections.dataStores.branches.documents.html | 10 +- ...tions.collections.dataStores.branches.html | 31 + ...ions.dataStores.completionSuggestions.html | 2 +- ...tions.collections.dataStores.controls.html | 12 +- ...ects.locations.collections.dataStores.html | 20 + ...collections.dataStores.servingConfigs.html | 2 + ...ons.collections.dataStores.userEvents.html | 2 +- ...ocations.collections.engines.controls.html | 12 +- ...ns.collections.engines.servingConfigs.html | 2 + ...cations.dataStores.branches.documents.html | 10 +- ...rojects.locations.dataStores.branches.html | 31 + ...ions.dataStores.completionSuggestions.html | 2 +- ...rojects.locations.dataStores.controls.html | 12 +- ..._v1beta.projects.locations.dataStores.html | 20 + ...s.locations.dataStores.servingConfigs.html | 2 + ...jects.locations.dataStores.userEvents.html | 2 +- ...v1beta.projects.locations.evaluations.html | 3 + ...a.projects.locations.groundingConfigs.html | 1 + ...cations.sampleQuerySets.sampleQueries.html | 2 +- ...displayvideo_v2.advertisers.creatives.html | 12 +- docs/dyn/dlp_v2.infoTypes.html | 2 +- docs/dyn/dlp_v2.locations.infoTypes.html | 2 +- ..._v2.organizations.deidentifyTemplates.html | 40 +- ...dlp_v2.organizations.inspectTemplates.html | 4 +- ...2.organizations.locations.connections.html | 2 +- ...zations.locations.deidentifyTemplates.html | 40 +- ...anizations.locations.discoveryConfigs.html | 118 ++- ...lp_v2.organizations.locations.dlpJobs.html | 22 +- ...tions.locations.fileStoreDataProfiles.html | 78 +- ...anizations.locations.inspectTemplates.html | 4 +- ...2.organizations.locations.jobTriggers.html | 16 +- ...ganizations.locations.storedInfoTypes.html | 4 +- ...nizations.locations.tableDataProfiles.html | 70 ++ .../dlp_v2.organizations.storedInfoTypes.html | 4 +- docs/dyn/dlp_v2.projects.content.html | 30 +- .../dlp_v2.projects.deidentifyTemplates.html | 40 +- docs/dyn/dlp_v2.projects.dlpJobs.html | 66 +- docs/dyn/dlp_v2.projects.image.html | 2 +- .../dyn/dlp_v2.projects.inspectTemplates.html | 4 +- docs/dyn/dlp_v2.projects.jobTriggers.html | 36 +- ...dlp_v2.projects.locations.connections.html | 2 +- .../dlp_v2.projects.locations.content.html | 30 +- ...rojects.locations.deidentifyTemplates.html | 40 +- ...2.projects.locations.discoveryConfigs.html | 118 ++- .../dlp_v2.projects.locations.dlpJobs.html | 66 +- ...jects.locations.fileStoreDataProfiles.html | 78 +- docs/dyn/dlp_v2.projects.locations.image.html | 2 +- ...2.projects.locations.inspectTemplates.html | 4 +- ...dlp_v2.projects.locations.jobTriggers.html | 36 +- ...v2.projects.locations.storedInfoTypes.html | 4 +- ....projects.locations.tableDataProfiles.html | 70 ++ docs/dyn/dlp_v2.projects.storedInfoTypes.html | 4 +- ...ntai_v1.projects.locations.processors.html | 1 + ...ocations.processors.processorVersions.html | 1 + ...v1beta3.projects.locations.processors.html | 1 + ...ocations.processors.processorVersions.html | 1 + docs/dyn/drive_v2.changes.html | 12 +- docs/dyn/drive_v2.files.html | 78 +- docs/dyn/drive_v2.parents.html | 8 +- docs/dyn/drive_v2.revisions.html | 12 +- docs/dyn/drive_v3.changes.html | 4 +- docs/dyn/drive_v3.files.html | 32 +- docs/dyn/drive_v3.revisions.html | 8 +- ....projects.locations.publishers.models.html | 12 +- ...hub_v1.organizations.locations.fleets.html | 8 + .../gkehub_v1.projects.locations.fleets.html | 32 + ...1alpha.organizations.locations.fleets.html | 8 + ...hub_v1alpha.projects.locations.fleets.html | 32 + ...v1beta.organizations.locations.fleets.html | 8 + ...ehub_v1beta.projects.locations.fleets.html | 32 + docs/dyn/gkehub_v2.html | 111 +++ docs/dyn/gkehub_v2.projects.html | 91 +++ docs/dyn/gkehub_v2.projects.locations.html | 176 +++++ ...ehub_v2.projects.locations.operations.html | 214 ++++++ docs/dyn/gkehub_v2beta.html | 111 +++ docs/dyn/gkehub_v2beta.projects.html | 91 +++ .../dyn/gkehub_v2beta.projects.locations.html | 176 +++++ ..._v2beta.projects.locations.operations.html | 214 ++++++ ...ts.locations.datasets.fhirStores.fhir.html | 32 + docs/dyn/index.md | 6 +- ...ns_v1.projects.locations.certificates.html | 12 +- ...ons_v1.projects.locations.connections.html | 5 + ...cts.locations.integrations.executions.html | 47 +- ...ns_v1.projects.locations.integrations.html | 21 +- ...jects.locations.integrations.versions.html | 170 +---- ...jects.locations.products.certificates.html | 12 +- ...ions.products.integrations.executions.html | 42 +- ...jects.locations.products.integrations.html | 21 +- ...ations.products.integrations.versions.html | 170 +---- ...tions_v1.projects.locations.templates.html | 428 ++--------- ...ounts.languages.productCertifications.html | 36 + .../manufacturers_v1.accounts.products.html | 29 + ...er_v1alpha1.projects.locations.assets.html | 84 +++ ...ha1.projects.locations.preferenceSets.html | 44 ++ ...jects.locations.reportConfigs.reports.html | 96 +++ ...rojects.locations.sources.errorFrames.html | 24 + ...ty_v1.projects.locations.global_.hubs.html | 3 + ...ectivity_v1.projects.locations.spokes.html | 12 + ...ha1.projects.locations.internalRanges.html | 16 + ...management_v1beta1.projects.locations.html | 5 + ...projects.locations.vpcFlowLogsConfigs.html | 88 +-- docs/dyn/playintegrity_v1.deviceRecall.html | 2 +- docs/dyn/playintegrity_v1.v1.html | 4 +- .../recaptchaenterprise_v1.projects.keys.html | 78 ++ .../redis_v1.projects.locations.clusters.html | 112 ++- ...s_v1beta1.projects.locations.clusters.html | 112 ++- ....projects.locations.catalogs.controls.html | 12 +- ....projects.locations.catalogs.controls.html | 12 +- ....projects.locations.catalogs.controls.html | 12 +- .../dyn/run_v2.projects.locations.builds.html | 156 ++++ docs/dyn/run_v2.projects.locations.html | 5 + ...v2.projects.locations.jobs.executions.html | 4 +- ...jects.locations.jobs.executions.tasks.html | 4 +- docs/dyn/run_v2.projects.locations.jobs.html | 10 +- .../run_v2.projects.locations.services.html | 8 +- ...projects.locations.services.revisions.html | 4 +- ...earchads360_v0.customers.searchAds360.html | 58 +- ..._v1.projects.instanceConfigOperations.html | 2 +- .../spanner_v1.projects.instanceConfigs.html | 42 +- ...spanner_v1.projects.instances.backups.html | 30 +- ...s.instances.databases.backupSchedules.html | 12 + docs/dyn/spanner_v1.projects.instances.html | 26 +- ...on_v1.projects.locations.imageImports.html | 12 +- ...ocations.imageImports.imageImportJobs.html | 4 +- ...gration_v1.projects.locations.sources.html | 21 - ...ations.sources.migratingVms.cloneJobs.html | 15 +- ...ions.sources.migratingVms.cutoverJobs.html | 15 +- ...ojects.locations.sources.migratingVms.html | 76 +- ...lpha1.projects.locations.imageImports.html | 12 +- ...ocations.imageImports.imageImportJobs.html | 4 +- ...n_v1alpha1.projects.locations.sources.html | 21 - ...ations.sources.migratingVms.cloneJobs.html | 27 +- ...ions.sources.migratingVms.cutoverJobs.html | 27 +- ...ojects.locations.sources.migratingVms.html | 124 ++- docs/dyn/youtube_v3.liveChatMessages.html | 2 +- docs/dyn/youtube_v3.playlists.html | 5 + .../documents/accesscontextmanager.v1.json | 6 +- .../documents/aiplatform.v1.json | 253 ++++++- .../documents/aiplatform.v1beta1.json | 272 ++++++- .../discovery_cache/documents/alloydb.v1.json | 310 +++++++- .../documents/alloydb.v1alpha.json | 414 +++++++++- .../documents/alloydb.v1beta.json | 342 ++++++++- .../documents/androidpublisher.v3.json | 12 +- .../discovery_cache/documents/apikeys.v2.json | 4 +- .../documents/artifactregistry.v1.json | 6 +- .../documents/artifactregistry.v1beta1.json | 6 +- .../documents/artifactregistry.v1beta2.json | 6 +- .../documents/backupdr.v1.json | 19 +- .../documents/beyondcorp.v1alpha.json | 711 +++++++++++++++++- .../documents/bigquery.v2.json | 53 +- .../documents/bigtableadmin.v2.json | 23 +- .../discovery_cache/documents/chat.v1.json | 10 +- .../documents/chromemanagement.v1.json | 6 +- .../documents/clouddeploy.v1.json | 6 +- .../documents/cloudtasks.v2.json | 6 +- .../documents/cloudtasks.v2beta2.json | 6 +- .../documents/cloudtasks.v2beta3.json | 6 +- .../documents/compute.alpha.json | 491 +----------- .../documents/compute.beta.json | 67 +- .../discovery_cache/documents/compute.v1.json | 29 +- .../documents/connectors.v1.json | 21 +- .../documents/container.v1.json | 35 +- .../documents/container.v1beta1.json | 18 +- .../documents/dataflow.v1b3.json | 29 +- .../documents/datamigration.v1.json | 138 +++- .../documents/dialogflow.v2.json | 289 +------ .../documents/dialogflow.v2beta1.json | 289 +------ .../documents/dialogflow.v3.json | 351 ++------- .../documents/dialogflow.v3beta1.json | 383 +++------- .../documents/discoveryengine.v1.json | 534 ++++++++++++- .../documents/discoveryengine.v1alpha.json | 430 ++++++++++- .../documents/discoveryengine.v1beta.json | 360 ++++++++- .../documents/displayvideo.v2.json | 45 +- .../documents/displayvideo.v3.json | 44 +- .../discovery_cache/documents/dlp.v2.json | 181 +++-- .../documents/documentai.v1.json | 6 +- .../documents/documentai.v1beta3.json | 6 +- .../discovery_cache/documents/drive.v2.json | 10 +- .../discovery_cache/documents/drive.v3.json | 8 +- .../documents/firebaseml.v2beta.json | 14 +- .../discovery_cache/documents/gkehub.v1.json | 44 +- .../documents/gkehub.v1alpha.json | 44 +- .../documents/gkehub.v1beta.json | 44 +- .../discovery_cache/documents/gkehub.v2.json | 435 +++++++++++ .../documents/gkehub.v2beta.json | 435 +++++++++++ .../documents/healthcare.v1beta1.json | 49 +- .../documents/integrations.v1.json | 355 ++------- .../documents/manufacturers.v1.json | 37 +- .../documents/migrationcenter.v1alpha1.json | 124 ++- .../documents/networkconnectivity.v1.json | 16 +- .../networkconnectivity.v1alpha1.json | 27 +- .../documents/networkmanagement.v1.json | 10 +- .../documents/networkmanagement.v1beta1.json | 312 +++++++- .../documents/playintegrity.v1.json | 8 +- .../documents/recaptchaenterprise.v1.json | 101 ++- .../discovery_cache/documents/redis.v1.json | 175 ++++- .../documents/redis.v1beta1.json | 175 ++++- .../discovery_cache/documents/retail.v2.json | 4 +- .../documents/retail.v2alpha.json | 4 +- .../documents/retail.v2beta.json | 4 +- .../discovery_cache/documents/run.v2.json | 150 +++- .../documents/searchads360.v0.json | 88 ++- .../documents/securitycenter.v1.json | 9 +- .../documents/securitycenter.v1beta1.json | 9 +- .../documents/securitycenter.v1beta2.json | 9 +- .../documents/serviceusage.v1.json | 104 ++- .../documents/serviceusage.v1beta1.json | 104 ++- .../discovery_cache/documents/spanner.v1.json | 92 ++- .../documents/vmmigration.v1.json | 150 ++-- .../documents/vmmigration.v1alpha1.json | 150 ++-- .../discovery_cache/documents/youtube.v3.json | 16 +- 370 files changed, 14899 insertions(+), 5905 deletions(-) create mode 100644 docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.applications.html create mode 100644 docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.hubs.html create mode 100644 docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html create mode 100644 docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.hubs.html create mode 100644 docs/dyn/datamigration_v1.projects.locations.migrationJobs.objects.html create mode 100644 docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.operations.html create mode 100644 docs/dyn/gkehub_v2.html create mode 100644 docs/dyn/gkehub_v2.projects.html create mode 100644 docs/dyn/gkehub_v2.projects.locations.html create mode 100644 docs/dyn/gkehub_v2.projects.locations.operations.html create mode 100644 docs/dyn/gkehub_v2beta.html create mode 100644 docs/dyn/gkehub_v2beta.projects.html create mode 100644 docs/dyn/gkehub_v2beta.projects.locations.html create mode 100644 docs/dyn/gkehub_v2beta.projects.locations.operations.html create mode 100644 docs/dyn/run_v2.projects.locations.builds.html create mode 100644 googleapiclient/discovery_cache/documents/gkehub.v2.json create mode 100644 googleapiclient/discovery_cache/documents/gkehub.v2beta.json diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index 4c57a03e76a..4cb24a15138 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -172,7 +172,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -207,7 +207,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -256,7 +256,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -291,7 +291,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -426,7 +426,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -461,7 +461,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -510,7 +510,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -545,7 +545,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -622,7 +622,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -657,7 +657,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -706,7 +706,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -741,7 +741,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -824,7 +824,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -859,7 +859,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -908,7 +908,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -943,7 +943,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1042,7 +1042,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1077,7 +1077,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1126,7 +1126,7 @@

Method Details

"egressPolicies": [ # List of EgressPolicies to apply to the perimeter. A perimeter may have multiple EgressPolicies, each of which is evaluated separately. Access is granted if any EgressPolicy grants it. Must be empty for a perimeter bridge. { # Policy for egress from perimeter. EgressPolicies match requests based on `egress_from` and `egress_to` stanzas. For an EgressPolicy to match, both `egress_from` and `egress_to` stanzas must be matched. If an EgressPolicy matches a request, the request is allowed to span the ServicePerimeter boundary. For example, an EgressPolicy can be used to allow VMs on networks within the ServicePerimeter to access a defined set of projects outside the perimeter in certain contexts (e.g. to read data from a Cloud Storage bucket or query against a BigQuery dataset). EgressPolicies are concerned with the *resources* that a request relates as well as the API services and API actions being used. They do not related to the direction of data movement. More detailed documentation for this concept can be found in the descriptions of EgressFrom and EgressTo. "egressFrom": { # Defines the conditions under which an EgressPolicy matches a request. Conditions based on information about the source of the request. Note that if the destination of the request is also protected by a ServicePerimeter, then that ServicePerimeter must have an IngressPolicy which allows access in order for this request to succeed. # Defines conditions on the source of a request causing this EgressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. @@ -1161,7 +1161,7 @@

Method Details

"ingressPolicies": [ # List of IngressPolicies to apply to the perimeter. A perimeter may have multiple IngressPolicies, each of which is evaluated separately. Access is granted if any Ingress Policy grants it. Must be empty for a perimeter bridge. { # Policy for ingress into ServicePerimeter. IngressPolicies match requests based on `ingress_from` and `ingress_to` stanzas. For an ingress policy to match, both the `ingress_from` and `ingress_to` stanzas must be matched. If an IngressPolicy matches a request, the request is allowed through the perimeter boundary from outside the perimeter. For example, access from the internet can be allowed either based on an AccessLevel or, for traffic hosted on Google Cloud, the project of the source network. For access from private networks, using the project of the hosting network is required. Individual ingress policies can be limited by restricting which services and/or actions they match using the `ingress_to` field. "ingressFrom": { # Defines the conditions under which an IngressPolicy matches a request. Conditions are based on information about the source of the request. The request must satisfy what is defined in `sources` AND identity related fields in order to match. # Defines the conditions on the source of a request causing this IngressPolicy to apply. - "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + "identities": [ # A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. "A String", ], "identityType": "A String", # Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of `identities` field will be allowed access. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 9cdfc7cad32..b9f9562066a 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -1276,6 +1276,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -1389,6 +1390,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -1505,7 +1507,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } @@ -2910,6 +2912,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -3023,6 +3026,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -3139,7 +3143,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html index 7c0ce32a5c9..1745b5288ef 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureGroups.html @@ -128,6 +128,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. @@ -227,6 +230,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. @@ -267,6 +273,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. @@ -313,6 +322,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html index 7f50a0a5ae7..6f4c4e80a2b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html @@ -122,6 +122,8 @@

Method Details

"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncSummary": { # Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync. # Output only. Summary of the sync job. "rowSynced": "A String", # Output only. Total number of rows synced. "totalSlot": "A String", # Output only. BigQuery slot milliseconds consumed for the sync job. @@ -165,6 +167,8 @@

Method Details

"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncSummary": { # Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync. # Output only. Summary of the sync job. "rowSynced": "A String", # Output only. Total number of rows synced. "totalSlot": "A String", # Output only. BigQuery slot milliseconds consumed for the sync job. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index 4f891b3ba45..f748e3e2aed 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -167,6 +167,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, @@ -380,6 +382,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, @@ -445,6 +449,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, @@ -516,6 +522,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. "cron": "A String", # Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html index 6f2a5d50734..f2c3c15ea8d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.html @@ -150,6 +150,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. } @@ -264,6 +266,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. } @@ -319,6 +323,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. }, @@ -380,6 +386,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. } diff --git a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.html b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.html index 25458f5d4ef..c9fc19e5759 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featurestores.entityTypes.html @@ -173,6 +173,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } @@ -426,6 +428,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } @@ -582,6 +586,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. }, ], @@ -638,6 +644,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } @@ -676,6 +684,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } diff --git a/docs/dyn/aiplatform_v1.projects.locations.featurestores.html b/docs/dyn/aiplatform_v1.projects.locations.featurestores.html index 29ebddfe744..adcb9e73a71 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featurestores.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featurestores.html @@ -247,6 +247,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. } @@ -350,6 +352,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. } @@ -430,6 +434,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. }, @@ -480,6 +486,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. } diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index c417e44ef72..868316b9dcb 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -310,6 +310,14 @@

Method Details

"version": 42, # Optional. Which version to use for evaluation. }, }, + "pairwiseMetricInput": { # Input for pairwise metric. # Input for pairwise metric. + "instance": { # Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. # Required. Pairwise metric instance. + "jsonInstance": "A String", # Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. + }, + "metricSpec": { # Spec for pairwise metric. # Required. Spec for pairwise metric. + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + }, + }, "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. @@ -336,6 +344,14 @@

Method Details

"version": 42, # Optional. Which version to use for evaluation. }, }, + "pointwiseMetricInput": { # Input for pointwise metric. # Input for pointwise metric. + "instance": { # Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. # Required. Pointwise metric instance. + "jsonInstance": "A String", # Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. + }, + "metricSpec": { # Spec for pointwise metric. # Required. Spec for pointwise metric. + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + }, + }, "questionAnsweringCorrectnessInput": { # Input for question answering correctness metric. # Input for question answering correctness metric. "instance": { # Spec for question answering correctness instance. # Required. Question answering correctness instance. "context": "A String", # Optional. Text provided as context to answer the question. @@ -527,6 +543,10 @@

Method Details

"explanation": "A String", # Output only. Explanation for groundedness score. "score": 3.14, # Output only. Groundedness score. }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, "pairwiseQuestionAnsweringQualityResult": { # Spec for pairwise question answering quality result. # Result for pairwise question answering quality metric. "confidence": 3.14, # Output only. Confidence for question answering quality score. "explanation": "A String", # Output only. Explanation for question answering quality score. @@ -537,6 +557,10 @@

Method Details

"explanation": "A String", # Output only. Explanation for summarization quality score. "pairwiseChoice": "A String", # Output only. Pairwise summarization prediction choice. }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Generic metrics. Result for pointwise metric. + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, "questionAnsweringCorrectnessResult": { # Spec for question answering correctness result. # Result for question answering correctness metric. "confidence": 3.14, # Output only. Confidence for question answering correctness score. "explanation": "A String", # Output only. Explanation for question answering correctness score. diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index f74b3d905c9..ede2538fcdc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -216,6 +216,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } @@ -607,6 +609,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } @@ -717,6 +721,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. }, ], @@ -933,6 +939,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } @@ -1031,6 +1039,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexes.html b/docs/dyn/aiplatform_v1.projects.locations.indexes.html index 8d81a7674f2..9724dbfbecc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexes.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexes.html @@ -148,6 +148,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. } @@ -256,6 +258,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. } @@ -307,6 +311,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. }, ], @@ -364,6 +370,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. } diff --git a/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.html b/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.html index 6dd5a0b2c71..df7a01f0367 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.modelDeploymentMonitoringJobs.html @@ -260,6 +260,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -409,6 +411,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -600,6 +604,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -762,6 +768,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -930,6 +938,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index c172926f355..25a391b19dc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -408,6 +408,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -521,6 +522,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -637,7 +639,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } @@ -993,6 +995,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -1106,6 +1109,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -1222,7 +1226,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 2f7d30d21d9..d2e8176854d 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

+ get(name, huggingFaceToken=None, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

Gets a Model Garden publisher model.

Method Details

@@ -87,11 +87,12 @@

Method Details

- get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None) + get(name, huggingFaceToken=None, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
 
 Args:
   name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
+  huggingFaceToken: string, Optional. Token used to access Hugging Face gated models.
   isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
   languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
   view: string, Optional. PublisherModel view specifying which fields to read.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index 7eb2eadc11a..6df1bdd5508 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -1472,6 +1472,7 @@ 

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -1628,6 +1629,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -1747,7 +1749,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, }
@@ -3270,6 +3272,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -3426,6 +3429,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -3545,7 +3549,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html index 91e140b6b84..f6be1d099ab 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureGroups.html @@ -128,6 +128,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. @@ -227,6 +230,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. @@ -267,6 +273,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. @@ -313,6 +322,9 @@

Method Details

"entityIdColumns": [ # Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. "A String", ], + "timeSeries": { # Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + "timestampColumn": "A String", # Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + }, }, "createTime": "A String", # Output only. Timestamp when this FeatureGroup was created. "description": "A String", # Optional. Description of the FeatureGroup. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html index 9074155d405..188fc2674e3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.html @@ -122,6 +122,8 @@

Method Details

"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncSummary": { # Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync. # Output only. Summary of the sync job. "rowSynced": "A String", # Output only. Total number of rows synced. "totalSlot": "A String", # Output only. BigQuery slot milliseconds consumed for the sync job. @@ -165,6 +167,8 @@

Method Details

"endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "syncSummary": { # Summary from the Sync job. For continuous syncs, the summary is updated periodically. For batch syncs, it gets updated on completion of the sync. # Output only. Summary of the sync job. "rowSynced": "A String", # Output only. Total number of rows synced. "totalSlot": "A String", # Output only. BigQuery slot milliseconds consumed for the sync job. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index f65bfb6047b..7c0bcfcad67 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -179,6 +179,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. @@ -410,6 +412,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. @@ -526,6 +530,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. @@ -613,6 +619,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}` + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "serviceAccountEmail": "A String", # Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. "serviceAgentType": "A String", # Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_VIEW`. This will generate a separate service account to access the BigQuery source table. "syncConfig": { # Configuration for Sync. Only one option is set. # Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html index 9a5f1df9e72..79ad2029bc2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.html @@ -162,6 +162,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. } @@ -279,6 +281,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. } @@ -372,6 +376,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. }, @@ -436,6 +442,8 @@

Method Details

"name": "A String", # Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}` "optimized": { # Optimized storage type # Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featureOnlineStore. "updateTime": "A String", # Output only. Timestamp when this FeatureOnlineStore was last updated. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.html index 15d3c5dfd39..28ac7b81591 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.entityTypes.html @@ -174,6 +174,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } @@ -428,6 +430,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. }
@@ -585,6 +589,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. }, ], @@ -642,6 +648,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } @@ -681,6 +689,8 @@

Method Details

}, "name": "A String", # Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. "offlineStorageTtlDays": 42, # Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this EntityType was most recently updated. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.html index d36054ae884..20eb9c5b437 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featurestores.html @@ -247,6 +247,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. } @@ -350,6 +352,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. } @@ -438,6 +442,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. }, @@ -488,6 +494,8 @@

Method Details

}, }, "onlineStorageTtlDays": 42, # Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # Output only. State of the featurestore. "updateTime": "A String", # Output only. Timestamp when this Featurestore was last updated. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 7c8dcdad67b..ba128fdc106 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -373,6 +373,14 @@

Method Details

"version": 42, # Optional. Which version to use for evaluation. }, }, + "pairwiseMetricInput": { # Input for pairwise metric. # Input for pairwise metric. + "instance": { # Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. # Required. Pairwise metric instance. + "jsonInstance": "A String", # Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. + }, + "metricSpec": { # Spec for pairwise metric. # Required. Spec for pairwise metric. + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + }, + }, "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. @@ -399,6 +407,14 @@

Method Details

"version": 42, # Optional. Which version to use for evaluation. }, }, + "pointwiseMetricInput": { # Input for pointwise metric. # Input for pointwise metric. + "instance": { # Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. # Required. Pointwise metric instance. + "jsonInstance": "A String", # Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. + }, + "metricSpec": { # Spec for pointwise metric. # Required. Spec for pointwise metric. + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + }, + }, "questionAnsweringCorrectnessInput": { # Input for question answering correctness metric. # Input for question answering correctness metric. "instance": { # Spec for question answering correctness instance. # Required. Question answering correctness instance. "context": "A String", # Optional. Text provided as context to answer the question. @@ -590,6 +606,10 @@

Method Details

"explanation": "A String", # Output only. Explanation for groundedness score. "score": 3.14, # Output only. Groundedness score. }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, "pairwiseQuestionAnsweringQualityResult": { # Spec for pairwise question answering quality result. # Result for pairwise question answering quality metric. "confidence": 3.14, # Output only. Confidence for question answering quality score. "explanation": "A String", # Output only. Explanation for question answering quality score. @@ -600,6 +620,10 @@

Method Details

"explanation": "A String", # Output only. Explanation for summarization quality score. "pairwiseChoice": "A String", # Output only. Pairwise summarization prediction choice. }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Generic metrics. Result for pointwise metric. + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, "questionAnsweringCorrectnessResult": { # Spec for question answering correctness result. # Result for question answering correctness metric. "confidence": 3.14, # Output only. Confidence for question answering correctness score. "explanation": "A String", # Output only. Explanation for question answering correctness score. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index 311e893086e..93a0fe8c27a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -216,6 +216,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } @@ -607,6 +609,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } @@ -717,6 +721,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. }, ], @@ -933,6 +939,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } @@ -1031,6 +1039,8 @@

Method Details

}, "publicEndpointDomainName": "A String", # Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. "publicEndpointEnabled": True or False, # Optional. If true, the deployed index will be accessible through public endpoint. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.html index b0a32c11f81..0159c441533 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexes.html @@ -148,6 +148,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. } @@ -256,6 +258,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. } @@ -307,6 +311,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. }, ], @@ -364,6 +370,8 @@

Method Details

"metadata": "", # An additional information about the Index; the schema of the metadata can be found in metadata_schema. "metadataSchemaUri": "A String", # Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. "name": "A String", # Output only. The resource name of the Index. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "updateTime": "A String", # Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.html index dc660282d84..eb3fcd8a3e2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelDeploymentMonitoringJobs.html @@ -260,6 +260,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -409,6 +411,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -600,6 +604,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -762,6 +768,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. @@ -930,6 +938,8 @@

Method Details

"nextScheduleTime": "A String", # Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. "predictInstanceSchemaUri": "A String", # YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests. "samplePredictInstance": "", # Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleState": "A String", # Output only. Schedule state when the monitoring job is in Running state. "state": "A String", # Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'. "statsAnomaliesBaseDirectory": { # The Google Cloud Storage location where the output is to be written to. # Stats anomalies base folder path. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 9875dffca29..21a3923de78 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -455,6 +455,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -611,6 +612,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -730,7 +732,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } @@ -1122,6 +1124,7 @@

Method Details

"modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. }, }, + "seed": 42, # Optional. Seed. "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -1278,6 +1281,7 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. + "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. "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. @@ -1397,7 +1401,7 @@

Method Details

}, "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. + "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. "totalTokenCount": 42, }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index fe542508d91..c3701ed1def 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -257,6 +257,10 @@

Method Details

"chunkOverlap": 42, # The overlap between chunks. "chunkSize": 42, # The size of the chunks. }, + "ragFileParsingConfig": { # Specifies the parsing config for RagFiles. # Specifies the parsing config for RagFiles. + "parsePdfsUsingOcr": True or False, # Whether to use OCR for PDFs. + "useAdvancedPdfParsing": True or False, # Whether to use advanced PDF parsing. + }, "slackSource": { # The Slack source for the ImportRagFilesRequest. # Slack channels with their corresponding access tokens. "channels": [ # Required. The Slack channels. { # SlackChannels contains the Slack channels and corresponding access token. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index cff0ff1eedb..f9ad6aefa71 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

+ get(name, huggingFaceToken=None, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)

Gets a Model Garden publisher model.

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

@@ -93,11 +93,12 @@

Method Details

- get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None) + get(name, huggingFaceToken=None, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
 
 Args:
   name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
+  huggingFaceToken: string, Optional. Token used to access Hugging Face gated models.
   isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
   languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
   view: string, Optional. PublisherModel view specifying which fields to read.
diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.html b/docs/dyn/alloydb_v1.projects.locations.clusters.html
index 3545626d843..c2b8dc17b5d 100644
--- a/docs/dyn/alloydb_v1.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1.projects.locations.clusters.html
@@ -260,6 +260,7 @@ 

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -436,6 +437,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -661,6 +663,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -817,6 +820,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -982,6 +986,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -1208,6 +1213,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index 3c67a440003..52deac2a5d3 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -834,6 +834,9 @@

Method Details

The object takes the form of: { + "nodeIds": [ # Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + "A String", + ], "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). "validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart. } diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index 777eae99fb3..3ae589ad768 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -117,6 +117,9 @@

Instance Methods

switchover(name, body=None, x__xgafv=None)

Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.

+

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

+

Upgrades a single Cluster. Imperative only.

Method Details

close() @@ -170,6 +173,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -264,6 +272,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -350,6 +359,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -444,6 +458,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -579,6 +594,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -673,6 +693,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -739,6 +760,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -833,6 +859,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -908,6 +935,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -1002,6 +1034,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -1138,6 +1171,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -1232,6 +1270,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -1319,4 +1358,49 @@

Method Details

}
+
+ upgrade(name, body=None, x__xgafv=None) +
Upgrades a single Cluster. Imperative only.
+
+Args:
+  name: string, Required. The resource name of the cluster. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Upgrades a cluster.
+  "etag": "A String", # Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
+  "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  "validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.
+  "version": "A String", # Required. The version the cluster is going to be upgraded to.
+}
+
+  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/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 8021d0c5608..407fc4bcd71 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -181,6 +181,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -318,6 +319,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -546,6 +548,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -734,6 +737,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -860,6 +864,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -943,6 +948,9 @@

Method Details

The object takes the form of: { + "nodeIds": [ # Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + "A String", + ], "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). "validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart. } diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index f90688202db..ed6f597b556 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -170,6 +170,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -263,6 +268,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -349,6 +355,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -442,6 +453,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -577,6 +589,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -670,6 +687,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -736,6 +754,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -829,6 +852,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -904,6 +928,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -997,6 +1026,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, @@ -1133,6 +1163,11 @@

Method Details

"backupName": "A String", # Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} "backupUid": "A String", # Output only. The system-generated UID of the backup which was used to create this resource. The UID is generated when the backup is created, and it is retained until the backup is deleted. }, + "cloudsqlBackupRunSource": { # The source CloudSQL backup resource. # Output only. Cluster created from CloudSQL snapshot. + "backupRunId": "A String", # Required. The CloudSQL backup run ID. + "instanceId": "A String", # Required. The CloudSQL instance ID. + "project": "A String", # The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + }, "clusterType": "A String", # Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` "continuousBackupConfig": { # ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. # Optional. Continuous backup configuration for this cluster. "enabled": True or False, # Whether ContinuousBackup is enabled. @@ -1226,6 +1261,7 @@

Method Details

"subscriptionType": "A String", # Optional. Subscription type of the cluster. "trialMetadata": { # Contains information and all metadata related to TRIAL clusters. # Output only. Metadata for free trial clusters "endTime": "A String", # End time of the trial cluster. + "graceEndTime": "A String", # grace end time of the cluster. "startTime": "A String", # start time of the trial cluster. "upgradeTime": "A String", # Upgrade time of trial cluster to Standard cluster. }, diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index cd4ac34e73c..acbb41b39ae 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -181,6 +181,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -317,6 +318,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -544,6 +546,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -731,6 +734,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -856,6 +860,7 @@

Method Details

"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. "recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "off" by default. "trackActiveQueries": True or False, # Track actively running queries on the instance. If not set, this flag is "off" by default. + "trackClientAddress": True or False, # Track client address for an instance. If not set, default value is "off". "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, @@ -938,6 +943,9 @@

Method Details

The object takes the form of: { + "nodeIds": [ # Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + "A String", + ], "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). "validateOnly": True or False, # Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart. } diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html index b45f312c772..15477e03e0f 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html @@ -198,6 +198,8 @@

Method Details

{ # Request for the purchases.subscriptionsv2.revoke API. "revocationContext": { # Revocation context of the purchases.subscriptionsv2.revoke API. # Required. Additional details around the subscription revocation. + "fullRefund": { # Used to determine if the refund type in the RevocationContext is a full refund. # Optional. Used when users should be refunded the full amount of the latest order of the subscription. + }, "proratedRefund": { # Used to determine if the refund type in the RevocationContext is a prorated refund. # Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription. }, }, diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html index 84afb3594dd..7c2931178bb 100644 --- a/docs/dyn/apikeys_v2.projects.locations.keys.html +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -140,7 +140,7 @@

Method Details

"methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*` "A String", ], - "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. + "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. }, ], "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key. @@ -267,7 +267,7 @@

Method Details

"methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*` "A String", ], - "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. + "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. }, ], "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key. @@ -353,7 +353,7 @@

Method Details

"methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*` "A String", ], - "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. + "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. }, ], "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key. @@ -427,7 +427,7 @@

Method Details

"methods": [ # Optional. List of one or more methods that can be called. If empty, all methods for the service are allowed. A wildcard (*) can be used as the last symbol. Valid examples: `google.cloud.translate.v2.TranslateService.GetSupportedLanguage` `TranslateText` `Get*` `translate.googleapis.com.Get*` "A String", ], - "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. + "service": "A String", # The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. }, ], "browserKeyRestrictions": { # The HTTP referrers (websites) that are allowed to use the key. # The HTTP referrers (websites) that are allowed to use the key. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html index 76065343cc0..04d3a374ca0 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.files.html @@ -207,7 +207,7 @@

Method Details

Args: parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an ID starting with "a/b/". * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Files owned by the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name "my_file.txt" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * "annotations.external_link:external_link_value" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-file`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" orderBy: string, The field to order the results by. pageSize: integer, The maximum number of files to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html index 1521c991c93..210a0f22d13 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name "my-tag" in package "my-package" in repository "my-repo" in project "my-project" in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html index e9198e23df1..c5fbd06360b 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.files.html @@ -127,7 +127,7 @@

Method Details

Args: parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an ID starting with "a/b/". * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Files owned by the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name "my_file.txt" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * "annotations.external_link:external_link_value" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-file`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" pageSize: integer, The maximum number of files to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html index 1196c545954..1bf022b4836 100644 --- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html +++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name "my-tag" in package "my-package" in repository "my-repo" in project "my-project" in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html index b08f2aade8b..641783f0cc2 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.files.html @@ -168,7 +168,7 @@

Method Details

Args: parent: string, Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*"` --> Files with an ID starting with "a/b/". * `owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Files owned by the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name "my_file.txt" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * "annotations.external_link:external_link_value" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-file`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" pageSize: integer, The maximum number of files to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html index eb11fde56e6..588a1189207 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html @@ -174,7 +174,7 @@

Method Details

Args: parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required) - filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. + filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name "my-tag" in package "my-package" in repository "my-repo" in project "my-project" in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000. pageToken: string, The next_page_token value returned from a previous list request, if any. x__xgafv: string, V1 error format. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html index dfe085373fb..249ce57ed83 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html @@ -119,7 +119,6 @@

Method Details

"resourceType": "A String", # Output only. Output Only. Resource type of workload on which backupplan is applied "rulesConfigInfo": [ # Output only. The config info related to backup rules. { # Message for rules config info. - "dataSource": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "lastBackupError": { # 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. Output Only. google.rpc.Status object to store the last backup error. "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. @@ -228,7 +227,6 @@

Method Details

"resourceType": "A String", # Output only. Output Only. Resource type of workload on which backupplan is applied "rulesConfigInfo": [ # Output only. The config info related to backup rules. { # Message for rules config info. - "dataSource": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "lastBackupError": { # 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. Output Only. google.rpc.Status object to store the last backup error. "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. @@ -276,7 +274,6 @@

Method Details

"resourceType": "A String", # Output only. Output Only. Resource type of workload on which backupplan is applied "rulesConfigInfo": [ # Output only. The config info related to backup rules. { # Message for rules config info. - "dataSource": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} "lastBackupError": { # 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. Output Only. google.rpc.Status object to store the last backup error. "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. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index cedc006a9e4..ab18d27a62a 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -111,8 +111,6 @@

Method Details

"backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message. { # `BackupRule` binds the backup schedule to a retention policy. "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. - "backupVault": "A String", # Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} - "backupVaultServiceAccount": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/. "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Required. Defines a schedule that runs within the confines of a defined window of time. "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window. @@ -237,8 +235,6 @@

Method Details

"backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message. { # `BackupRule` binds the backup schedule to a retention policy. "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. - "backupVault": "A String", # Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} - "backupVaultServiceAccount": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/. "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Required. Defines a schedule that runs within the confines of a defined window of time. "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window. @@ -303,8 +299,6 @@

Method Details

"backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message. { # `BackupRule` binds the backup schedule to a retention policy. "backupRetentionDays": 42, # Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. - "backupVault": "A String", # Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} - "backupVaultServiceAccount": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. "ruleId": "A String", # Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/. "standardSchedule": { # `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. # Required. Defines a schedule that runs within the confines of a defined window of time. "backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.applications.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.applications.html new file mode 100644 index 00000000000..b1af548e0aa --- /dev/null +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.applications.html @@ -0,0 +1,241 @@ + + + +

BeyondCorp API . projects . locations . global_ . securityGateways . applications

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new Application in a given project and location.

+

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

+

Updates the parameters of a single Application.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, applicationId=None, body=None, requestId=None, x__xgafv=None) +
Creates a new Application in a given project and location.
+
+Args:
+  parent: string, Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Beyondcorp Application resource information.
+  "applicationMatchFilter": { # Match Criteria for Application Filtering. # Required. Application filter conditions associated with an application.
+    "matchConditions": [ # Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - ("*.abc.com"), ("xyz.abc.com") FQDN and PORTS - ("abc.com" and "22"), ("abc.com" and "22,33)" etc IP_ADDRESS - ("10.20.30.40"), ("100.20.30.40") IP_ADDRESS and PORTS - ("10.20.30.40" and "4"), ("10.20.30.40" and "4,5")
+      { # Match condition for idenfying the application.
+        "fqdn": "A String", # Optional. FQDN of the application.
+        "ipAddress": "A String", # Optional. IP Address of the application.
+        "ports": [ # Optional. Ports of the application.
+          42,
+        ],
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when the resource was created.
+  "displayName": "A String", # Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.
+  "name": "A String", # Identifier. Name of the resource.
+  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+}
+
+  applicationId: string, Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
+  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.
+  },
+}
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single Application.
+
+Args:
+  name: string, Identifier. Name of the resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Beyondcorp Application resource information.
+  "applicationMatchFilter": { # Match Criteria for Application Filtering. # Required. Application filter conditions associated with an application.
+    "matchConditions": [ # Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - ("*.abc.com"), ("xyz.abc.com") FQDN and PORTS - ("abc.com" and "22"), ("abc.com" and "22,33)" etc IP_ADDRESS - ("10.20.30.40"), ("100.20.30.40") IP_ADDRESS and PORTS - ("10.20.30.40" and "4"), ("10.20.30.40" and "4,5")
+      { # Match condition for idenfying the application.
+        "fqdn": "A String", # Optional. FQDN of the application.
+        "ipAddress": "A String", # Optional. IP Address of the application.
+        "ports": [ # Optional. Ports of the application.
+          42,
+        ],
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when the resource was created.
+  "displayName": "A String", # Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.
+  "name": "A String", # Identifier. Name of the resource.
+  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Required. Mutable fields include: display_name.
+  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.
+  },
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A 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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.html index 16b1c14a797..54776542475 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.html @@ -75,267 +75,22 @@

BeyondCorp API . projects . locations . global_ . securityGateways

Instance Methods

- close()

-

Close httplib2 connections.

-

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

-

Creates a new SecurityGateway in a given project and global location.

-

- delete(name, requestId=None, validateOnly=None, x__xgafv=None)

-

Deletes a single SecurityGateway.

-

- get(name, x__xgafv=None)

-

Gets details of a single SecurityGateway.

-

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

-

Lists SecurityGateways in a given project and global location.

+ applications() +

+

Returns the applications Resource.

+

- list_next()

-

Retrieves the next page of results.

+ hubs() +

+

Returns the hubs Resource.

+

- patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

-

Updates the parameters of a single SecurityGateway.

+ close()

+

Close httplib2 connections.

Method Details

close()
Close httplib2 connections.
-
- create(parent, body=None, requestId=None, securityGatewayId=None, x__xgafv=None) -
Creates a new SecurityGateway in a given project and global location.
-
-Args:
-  parent: string, Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/global` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Information about a BeyoncCorp SecurityGateway resource.
-  "createTime": "A String", # Output only. Timestamp when the resource was created.
-  "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
-  "name": "A String", # Identifier. Name of the resource.
-  "regionConfigs": [ # Optional. List of regions where the egress connectivity is required.
-    { # Message contains the configuration for each supported region for the securityGateway instance.
-      "egressIpAddresses": [ # Output only. External IP addresses that will be used for establishing connection to the egress endpoints.
-        "A String",
-      ],
-      "region": "A String", # Required. The region where the egress connectivity is required.
-    },
-  ],
-  "state": "A String", # Output only. The operational state of the SecurityGateway.
-  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
-}
-
-  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
-  securityGatewayId: string, Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
-  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, requestId=None, validateOnly=None, x__xgafv=None) -
Deletes a single SecurityGateway.
-
-Args:
-  name: string, Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}` (required)
-  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
-  validateOnly: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
-  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 details of a single SecurityGateway.
-
-Args:
-  name: string, Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Information about a BeyoncCorp SecurityGateway resource.
-  "createTime": "A String", # Output only. Timestamp when the resource was created.
-  "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
-  "name": "A String", # Identifier. Name of the resource.
-  "regionConfigs": [ # Optional. List of regions where the egress connectivity is required.
-    { # Message contains the configuration for each supported region for the securityGateway instance.
-      "egressIpAddresses": [ # Output only. External IP addresses that will be used for establishing connection to the egress endpoints.
-        "A String",
-      ],
-      "region": "A String", # Required. The region where the egress connectivity is required.
-    },
-  ],
-  "state": "A String", # Output only. The operational state of the SecurityGateway.
-  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
-}
-
- -
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists SecurityGateways in a given project and global location.
-
-Args:
-  parent: string, Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/` (required)
-  filter: string, Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160.
-  orderBy: string, Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
-  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
-  pageToken: string, Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Message for response to listing SecurityGateways.
-  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
-  "securityGateways": [ # A list of BeyondCorp SecurityGateway in the project.
-    { # Information about a BeyoncCorp SecurityGateway resource.
-      "createTime": "A String", # Output only. Timestamp when the resource was created.
-      "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
-      "name": "A String", # Identifier. Name of the resource.
-      "regionConfigs": [ # Optional. List of regions where the egress connectivity is required.
-        { # Message contains the configuration for each supported region for the securityGateway instance.
-          "egressIpAddresses": [ # Output only. External IP addresses that will be used for establishing connection to the egress endpoints.
-            "A String",
-          ],
-          "region": "A String", # Required. The region where the egress connectivity is required.
-        },
-      ],
-      "state": "A String", # Output only. The operational state of the SecurityGateway.
-      "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
-    },
-  ],
-  "unreachable": [ # A list of locations that could not be reached.
-    "A String",
-  ],
-}
-
- -
- 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, requestId=None, updateMask=None, x__xgafv=None) -
Updates the parameters of a single SecurityGateway.
-
-Args:
-  name: string, Identifier. Name of the resource. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Information about a BeyoncCorp SecurityGateway resource.
-  "createTime": "A String", # Output only. Timestamp when the resource was created.
-  "displayName": "A String", # Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.
-  "name": "A String", # Identifier. Name of the resource.
-  "regionConfigs": [ # Optional. List of regions where the egress connectivity is required.
-    { # Message contains the configuration for each supported region for the securityGateway instance.
-      "egressIpAddresses": [ # Output only. External IP addresses that will be used for establishing connection to the egress endpoints.
-        "A String",
-      ],
-      "region": "A String", # Required. The region where the egress connectivity is required.
-    },
-  ],
-  "state": "A String", # Output only. The operational state of the SecurityGateway.
-  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
-}
-
-  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
-  updateMask: string, Required. Mutable fields include: display_name, gateway_regions.
-  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/beyondcorp_v1alpha.projects.locations.global_.securityGateways.hubs.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.hubs.html new file mode 100644 index 00000000000..d67fdf634c5 --- /dev/null +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.global_.securityGateways.hubs.html @@ -0,0 +1,233 @@ + + + +

BeyondCorp API . projects . locations . global_ . securityGateways . hubs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new Hub in a given project and location.

+

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

+

Updates the parameters of a single Hub.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, hubId=None, requestId=None, x__xgafv=None) +
Creates a new Hub in a given project and location.
+
+Args:
+  parent: string, Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Beyondcorp Hub resource information.
+  "createTime": "A String", # Output only. Timestamp when the resource was created.
+  "displayName": "A String", # Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.
+  "name": "A String", # Identifier. Name of the resource.
+  "natGatewayConfig": { # Represents the NAT Gateway configuration. # Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits.
+    "enableNatGateway": True or False, # Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.
+    "natIps": [ # Output only. List of NAT IPs that will be used for establishing connection to the endpoints.
+      "A String",
+    ],
+  },
+  "state": "A String", # Output only. The operational state of the Hub.
+  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+}
+
+  hubId: string, Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.
+  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.
+  },
+}
+
+ +
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the parameters of a single Hub.
+
+Args:
+  name: string, Identifier. Name of the resource. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Beyondcorp Hub resource information.
+  "createTime": "A String", # Output only. Timestamp when the resource was created.
+  "displayName": "A String", # Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.
+  "name": "A String", # Identifier. Name of the resource.
+  "natGatewayConfig": { # Represents the NAT Gateway configuration. # Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits.
+    "enableNatGateway": True or False, # Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.
+    "natIps": [ # Output only. List of NAT IPs that will be used for establishing connection to the endpoints.
+      "A String",
+    ],
+  },
+  "state": "A String", # Output only. The operational state of the Hub.
+  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Required. Mutable fields include: display_name.
+  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.
+  },
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A 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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.html index 2629dca9119..2231440d8f8 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.html @@ -119,6 +119,11 @@

Instance Methods

Returns the connectors Resource.

+

+ global_() +

+

Returns the global_ Resource.

+

insights()

diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html new file mode 100644 index 00000000000..9f07a5b6eca --- /dev/null +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.applications.html @@ -0,0 +1,227 @@ + + + +

BeyondCorp API . projects . locations . securityGateways . applications

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, requestId=None, validateOnly=None, x__xgafv=None)

+

Deletes a single Application.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Application.

+

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

+

Lists Applications in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, requestId=None, validateOnly=None, x__xgafv=None) +
Deletes a single Application.
+
+Args:
+  name: string, Required. Name of the resource. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
+  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 details of a single Application.
+
+Args:
+  name: string, Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_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 Beyondcorp Application resource information.
+  "applicationMatchFilter": { # Match Criteria for Application Filtering. # Required. Application filter conditions associated with an application.
+    "matchConditions": [ # Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - ("*.abc.com"), ("xyz.abc.com") FQDN and PORTS - ("abc.com" and "22"), ("abc.com" and "22,33)" etc IP_ADDRESS - ("10.20.30.40"), ("100.20.30.40") IP_ADDRESS and PORTS - ("10.20.30.40" and "4"), ("10.20.30.40" and "4,5")
+      { # Match condition for idenfying the application.
+        "fqdn": "A String", # Optional. FQDN of the application.
+        "ipAddress": "A String", # Optional. IP Address of the application.
+        "ports": [ # Optional. Ports of the application.
+          42,
+        ],
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when the resource was created.
+  "displayName": "A String", # Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.
+  "name": "A String", # Identifier. Name of the resource.
+  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Applications in a given project and location.
+
+Args:
+  parent: string, Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}` (required)
+  filter: string, Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-application" For more information, please refer to https://google.aip.dev/160.
+  orderBy: string, Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
+  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
+  pageToken: string, Optional. The next_page_token value returned from a previous ListHubsRequest, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Applications.
+  "applications": [ # A list of BeyondCorp Application in the project.
+    { # A Beyondcorp Application resource information.
+      "applicationMatchFilter": { # Match Criteria for Application Filtering. # Required. Application filter conditions associated with an application.
+        "matchConditions": [ # Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - ("*.abc.com"), ("xyz.abc.com") FQDN and PORTS - ("abc.com" and "22"), ("abc.com" and "22,33)" etc IP_ADDRESS - ("10.20.30.40"), ("100.20.30.40") IP_ADDRESS and PORTS - ("10.20.30.40" and "4"), ("10.20.30.40" and "4,5")
+          { # Match condition for idenfying the application.
+            "fqdn": "A String", # Optional. FQDN of the application.
+            "ipAddress": "A String", # Optional. IP Address of the application.
+            "ports": [ # Optional. Ports of the application.
+              42,
+            ],
+          },
+        ],
+      },
+      "createTime": "A String", # Output only. Timestamp when the resource was created.
+      "displayName": "A String", # Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.
+      "name": "A String", # Identifier. Name of the resource.
+      "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # A list of locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ 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/beyondcorp_v1alpha.projects.locations.securityGateways.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html index f646ab840d4..e1cfed07624 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.html @@ -74,6 +74,16 @@

BeyondCorp API . projects . locations . securityGateways

Instance Methods

+

+ applications() +

+

Returns the applications Resource.

+ +

+ hubs() +

+

Returns the hubs Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.hubs.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.hubs.html new file mode 100644 index 00000000000..7693c3d8598 --- /dev/null +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.securityGateways.hubs.html @@ -0,0 +1,219 @@ + + + +

BeyondCorp API . projects . locations . securityGateways . hubs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, requestId=None, validateOnly=None, x__xgafv=None)

+

Deletes a single Hub.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Hub.

+

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

+

Lists Hubs in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, requestId=None, validateOnly=None, x__xgafv=None) +
Deletes a single Hub.
+
+Args:
+  name: string, Required. Name of the resource. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  validateOnly: boolean, Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
+  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 details of a single Hub.
+
+Args:
+  name: string, Required. The resource name of the Hub using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/hubs/{hub_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 Beyondcorp Hub resource information.
+  "createTime": "A String", # Output only. Timestamp when the resource was created.
+  "displayName": "A String", # Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.
+  "name": "A String", # Identifier. Name of the resource.
+  "natGatewayConfig": { # Represents the NAT Gateway configuration. # Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits.
+    "enableNatGateway": True or False, # Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.
+    "natIps": [ # Output only. List of NAT IPs that will be used for establishing connection to the endpoints.
+      "A String",
+    ],
+  },
+  "state": "A String", # Output only. The operational state of the Hub.
+  "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Hubs in a given project and location.
+
+Args:
+  parent: string, Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}` (required)
+  filter: string, Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-hub" For more information, please refer to https://google.aip.dev/160.
+  orderBy: string, Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
+  pageSize: integer, Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
+  pageToken: string, Optional. The next_page_token value returned from a previous ListHubsRequest, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Hubs.
+  "hubs": [ # A list of BeyondCorp Hub in the project.
+    { # A Beyondcorp Hub resource information.
+      "createTime": "A String", # Output only. Timestamp when the resource was created.
+      "displayName": "A String", # Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.
+      "name": "A String", # Identifier. Name of the resource.
+      "natGatewayConfig": { # Represents the NAT Gateway configuration. # Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits.
+        "enableNatGateway": True or False, # Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.
+        "natIps": [ # Output only. List of NAT IPs that will be used for establishing connection to the endpoints.
+          "A String",
+        ],
+      },
+      "state": "A String", # Output only. The operational state of the Hub.
+      "updateTime": "A String", # Output only. Timestamp when the resource was last modified.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
+  "unreachable": [ # A list of locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ 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/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index cf9b3f4820a..29a5d223f2a 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -261,17 +261,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -493,17 +493,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1318,17 +1318,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1675,17 +1675,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1907,17 +1907,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2732,17 +2732,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2971,17 +2971,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3170,17 +3170,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3402,17 +3402,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -4227,17 +4227,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -4555,17 +4555,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -4787,17 +4787,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -5612,17 +5612,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -5963,17 +5963,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -6195,17 +6195,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -7022,17 +7022,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -7350,17 +7350,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 9564fc5fb36..78bc41bedc2 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -277,17 +277,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -426,17 +426,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -759,17 +759,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -908,17 +908,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1182,17 +1182,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1331,17 +1331,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1713,17 +1713,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -1862,17 +1862,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2137,17 +2137,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2286,17 +2286,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2679,17 +2679,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -2828,17 +2828,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3103,17 +3103,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. @@ -3252,17 +3252,17 @@

Method Details

], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataPolicies": [ # Optional. Data policy options, will replace the data_policies. + { # Data policy option proto, it currently supports name only, will support precedence later. + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. # Object with schema name: TableFieldSchema ], "foreignTypeDefinition": "A String", # Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required. - "identityColumnInfo": { # Metadata for value generation for an identity column. # Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields). - "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. - "increment": "A String", # Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified. - "start": "A String", # Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified. - }, "maxLength": "A String", # Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES". "mode": "A String", # Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. "name": "A String", # Required. The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html index 241499c98ba..32d3f8373d8 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.clusters.backups.html @@ -167,6 +167,7 @@

Method Details

The object takes the form of: { # A backup of a Cloud Bigtable table. + "backupType": "A String", # Indicates the backup type of the backup. "encryptionInfo": { # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. # Output only. The encryption information for the backup. "encryptionStatus": { # 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. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -181,7 +182,8 @@

Method Details

"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. }, "endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. - "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "hotToStandardTime": "A String", # The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. "name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. "sizeBytes": "A String", # Output only. Size of the backup in bytes. "sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ @@ -253,6 +255,7 @@

Method Details

An object of the form: { # A backup of a Cloud Bigtable table. + "backupType": "A String", # Indicates the backup type of the backup. "encryptionInfo": { # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. # Output only. The encryption information for the backup. "encryptionStatus": { # 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. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -267,7 +270,8 @@

Method Details

"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. }, "endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. - "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "hotToStandardTime": "A String", # The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. "name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. "sizeBytes": "A String", # Output only. Size of the backup in bytes. "sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ @@ -354,6 +358,7 @@

Method Details

{ # The response for ListBackups. "backups": [ # The list of matching backups. { # A backup of a Cloud Bigtable table. + "backupType": "A String", # Indicates the backup type of the backup. "encryptionInfo": { # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. # Output only. The encryption information for the backup. "encryptionStatus": { # 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. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -368,7 +373,8 @@

Method Details

"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. }, "endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. - "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "hotToStandardTime": "A String", # The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. "name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. "sizeBytes": "A String", # Output only. Size of the backup in bytes. "sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ @@ -405,6 +411,7 @@

Method Details

The object takes the form of: { # A backup of a Cloud Bigtable table. + "backupType": "A String", # Indicates the backup type of the backup. "encryptionInfo": { # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. # Output only. The encryption information for the backup. "encryptionStatus": { # 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. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -419,7 +426,8 @@

Method Details

"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. }, "endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. - "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "hotToStandardTime": "A String", # The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. "name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. "sizeBytes": "A String", # Output only. Size of the backup in bytes. "sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ @@ -438,6 +446,7 @@

Method Details

An object of the form: { # A backup of a Cloud Bigtable table. + "backupType": "A String", # Indicates the backup type of the backup. "encryptionInfo": { # Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. # Output only. The encryption information for the backup. "encryptionStatus": { # 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. The status of encrypt/decrypt calls on underlying data for this resource. Regardless of status, the existing data is always encrypted at rest. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -452,7 +461,8 @@

Method Details

"kmsKeyVersion": "A String", # Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table. }, "endTime": "A String", # Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. - "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "expireTime": "A String", # Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + "hotToStandardTime": "A String", # The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. "name": "A String", # A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. "sizeBytes": "A String", # Output only. Size of the backup in bytes. "sourceBackup": "A String", # Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/ diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index c69150bc657..3cc2c5d8f86 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -1875,7 +1875,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -3649,7 +3649,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -5441,7 +5441,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -7221,7 +7221,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -9006,7 +9006,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -10774,7 +10774,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -12542,7 +12542,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -14310,7 +14310,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index bdad12ded10..90060dda36e 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -1990,7 +1990,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -3753,7 +3753,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -5516,7 +5516,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -7277,7 +7277,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -9036,7 +9036,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -10795,7 +10795,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -12843,7 +12843,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -14606,7 +14606,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -16369,7 +16369,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -18130,7 +18130,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -19889,7 +19889,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. @@ -21648,7 +21648,7 @@

Method Details

}, "text": "A String", # Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/workspace/chat/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/workspace/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/workspace/chat/create-messages#create-text-messages). "thread": { # A thread in a Google Chat space. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). If you specify a thread when creating a message, you can set the [`messageReplyOption`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/create#messagereplyoption) field to determine what happens if no matching thread is found. # The thread the message belongs to. For example usage, see [Start or reply to a message thread](https://developers.google.com/workspace/chat/create-messages#create-message-thread). - "name": "A String", # Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}` + "name": "A String", # Resource name of the thread. Example: `spaces/{space}/threads/{thread}` "threadKey": "A String", # Optional. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread `name` field instead. }, "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`. diff --git a/docs/dyn/chromemanagement_v1.customers.telemetry.users.html b/docs/dyn/chromemanagement_v1.customers.telemetry.users.html index 60ac3d0e83b..cb18664855a 100644 --- a/docs/dyn/chromemanagement_v1.customers.telemetry.users.html +++ b/docs/dyn/chromemanagement_v1.customers.telemetry.users.html @@ -98,7 +98,7 @@

Method Details

Args: name: string, Required. Name of the `TelemetryUser` to return. (required) - readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report + readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report - user_device.app_report x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -185,7 +185,7 @@

Method Details

filter: string, Only include resources that match the filter. Supported filter fields: - user_id - user_org_unit_id pageSize: integer, Maximum number of results to return. Default value is 100. Maximum value is 1000. pageToken: string, Token to specify next page in the list. - readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report + readMask: string, Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report - user_device.app_report x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html index b957184d673..8cbd233b445 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automationRuns.html @@ -181,7 +181,7 @@

Method Details

}, }, "destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase. - "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence "id": "A String", # Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. "wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target. }, @@ -205,7 +205,7 @@

Method Details

"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied. "targets": [ # Contains attributes about a target. { # Contains criteria for selecting Targets. - "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location "labels": { # Target labels. "a_key": "A String", }, @@ -332,7 +332,7 @@

Method Details

}, }, "destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase. - "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence "id": "A String", # Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. "wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target. }, @@ -356,7 +356,7 @@

Method Details

"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied. "targets": [ # Contains attributes about a target. { # Contains criteria for selecting Targets. - "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location "labels": { # Target labels. "a_key": "A String", }, diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html index 05e74646bb0..ce543ebfd7d 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.automations.html @@ -150,7 +150,7 @@

Method Details

}, }, "destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase. - "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence "id": "A String", # Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. "wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target. }, @@ -174,7 +174,7 @@

Method Details

"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied. "targets": [ # Contains attributes about a target. { # Contains criteria for selecting Targets. - "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location "labels": { # Target labels. "a_key": "A String", }, @@ -312,7 +312,7 @@

Method Details

}, }, "destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase. - "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence "id": "A String", # Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. "wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target. }, @@ -336,7 +336,7 @@

Method Details

"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied. "targets": [ # Contains attributes about a target. { # Contains criteria for selecting Targets. - "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location "labels": { # Target labels. "a_key": "A String", }, @@ -410,7 +410,7 @@

Method Details

}, }, "destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase. - "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence "id": "A String", # Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. "wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target. }, @@ -434,7 +434,7 @@

Method Details

"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied. "targets": [ # Contains attributes about a target. { # Contains criteria for selecting Targets. - "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location "labels": { # Target labels. "a_key": "A String", }, @@ -517,7 +517,7 @@

Method Details

}, }, "destinationPhase": "A String", # Optional. The starting phase of the rollout created by this operation. Default to the first phase. - "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + "destinationTargetId": "A String", # Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence "id": "A String", # Required. ID of the rule. This id must be unique in the `Automation` resource to which this rule belongs. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`. "wait": "A String", # Optional. How long the release need to be paused until being promoted to the next target. }, @@ -541,7 +541,7 @@

Method Details

"selector": { # AutomationResourceSelector contains the information to select the resources to which an Automation is going to be applied. # Required. Selected resources to which the automation will be applied. "targets": [ # Contains attributes about a target. { # Contains criteria for selecting Targets. - "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + "id": "A String", # ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location "labels": { # Target labels. "a_key": "A String", }, diff --git a/docs/dyn/cloudtasks_v2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2.projects.locations.queues.html index e1a20508436..22b3702e040 100644 --- a/docs/dyn/cloudtasks_v2.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2.projects.locations.queues.html @@ -150,11 +150,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -216,11 +216,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -307,11 +307,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -429,11 +429,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -513,11 +513,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -580,11 +580,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -659,11 +659,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -738,11 +738,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -817,11 +817,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html index 55d6c5884c8..f8e9f93dd1e 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html @@ -152,11 +152,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -229,11 +229,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -332,11 +332,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -466,11 +466,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -561,11 +561,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -639,11 +639,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -729,11 +729,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -819,11 +819,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -909,11 +909,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html index 4e9c90e8e29..54c804ba070 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.queues.html @@ -152,11 +152,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -230,11 +230,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -334,11 +334,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -469,11 +469,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -565,11 +565,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -644,11 +644,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -735,11 +735,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -826,11 +826,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, @@ -917,11 +917,11 @@

Method Details

}, ], "httpMethod": "A String", # The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. - "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. + "oauthToken": { # Contains information needed for generating an [OAuth token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. # If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. "scope": "A String", # OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, - "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. + "oidcToken": { # Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. # If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. "audience": "A String", # Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. "serviceAccountEmail": "A String", # [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue. The caller must have iam.serviceAccounts.actAs permission for the service account. }, diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index b74b7518dc2..9b2cf37431b 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -304,7 +304,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -1090,7 +1090,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -1717,7 +1717,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2327,7 +2327,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2835,7 +2835,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -3359,7 +3359,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -4455,7 +4455,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 20547da92bb..72abc33f76d 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -424,11 +424,6 @@

Instance Methods

Returns the regionInstantSnapshots Resource.

-

- regionMultiMigs() -

-

Returns the regionMultiMigs Resource.

-

regionNetworkEndpointGroups()

diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index fb4822d5db1..33737e9d0aa 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -277,7 +277,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -907,7 +907,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -1518,7 +1518,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2027,7 +2027,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -2552,7 +2552,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. @@ -3520,7 +3520,7 @@

Method Details

{ # Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. "dryRun": True or False, # If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. - "name": "A String", # Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. }, ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. diff --git a/docs/dyn/compute_alpha.vpnTunnels.html b/docs/dyn/compute_alpha.vpnTunnels.html index c29729e5412..0839ce6022b 100644 --- a/docs/dyn/compute_alpha.vpnTunnels.html +++ b/docs/dyn/compute_alpha.vpnTunnels.html @@ -142,16 +142,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -159,7 +159,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. }, @@ -367,16 +367,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -384,7 +384,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. } @@ -411,16 +411,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -428,7 +428,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. } @@ -585,16 +585,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -602,7 +602,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. }, diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index d4ceabb4a9b..790d447e837 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -396,6 +396,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -924,6 +926,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -1295,6 +1299,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -1648,6 +1654,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -1900,6 +1908,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -2168,6 +2178,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -3005,6 +3017,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. diff --git a/docs/dyn/compute_beta.forwardingRules.html b/docs/dyn/compute_beta.forwardingRules.html index 7bed3a10ce1..2f95ff51081 100644 --- a/docs/dyn/compute_beta.forwardingRules.html +++ b/docs/dyn/compute_beta.forwardingRules.html @@ -148,6 +148,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -400,6 +402,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -472,6 +476,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -673,6 +679,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -775,6 +783,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html index 84532a6534b..1d252d872a6 100644 --- a/docs/dyn/compute_beta.futureReservations.html +++ b/docs/dyn/compute_beta.futureReservations.html @@ -159,7 +159,6 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -607,7 +606,6 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -750,7 +748,6 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -1023,7 +1020,6 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -1199,7 +1195,6 @@

Method Details

], "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. diff --git a/docs/dyn/compute_beta.globalForwardingRules.html b/docs/dyn/compute_beta.globalForwardingRules.html index f028b1e0d66..77b1408ce3d 100644 --- a/docs/dyn/compute_beta.globalForwardingRules.html +++ b/docs/dyn/compute_beta.globalForwardingRules.html @@ -260,6 +260,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -331,6 +333,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -531,6 +535,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name @@ -632,6 +638,8 @@

Method Details

"baseForwardingRule": "A String", # [Output Only] The URL for the corresponding base forwarding rule. By base forwarding rule, we mean the forwarding rule that has the same IP address, protocol, and port settings with the current forwarding rule, but without sourceIPRanges specified. Always empty if the current forwarding rule does not have sourceIPRanges specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. + "externalManagedBackendBucketMigrationState": "A String", # Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedBackendBucketMigrationTestingPercentage": 3.14, # Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "ipCollection": "A String", # Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule using BYOIP: Full resource URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region /publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name - regions/region/publicDelegatedPrefixes/sub-pdp-name diff --git a/docs/dyn/compute_beta.machineTypes.html b/docs/dyn/compute_beta.machineTypes.html index 1dfb5e105ec..434a9826ded 100644 --- a/docs/dyn/compute_beta.machineTypes.html +++ b/docs/dyn/compute_beta.machineTypes.html @@ -126,6 +126,7 @@

Method Details

"guestAcceleratorType": "A String", # The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4. }, ], + "architecture": "A String", # [Output Only] The architecture of the machine type. "bundledLocalSsds": { # [Output Only] The configuration of bundled local SSD for the machine type. "defaultInterface": "A String", # The default disk interface if the interface is not specified. "partitionCount": 42, # The number of partitions. @@ -230,6 +231,7 @@

Method Details

"guestAcceleratorType": "A String", # The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4. }, ], + "architecture": "A String", # [Output Only] The architecture of the machine type. "bundledLocalSsds": { # [Output Only] The configuration of bundled local SSD for the machine type. "defaultInterface": "A String", # The default disk interface if the interface is not specified. "partitionCount": 42, # The number of partitions. @@ -292,6 +294,7 @@

Method Details

"guestAcceleratorType": "A String", # The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4. }, ], + "architecture": "A String", # [Output Only] The architecture of the machine type. "bundledLocalSsds": { # [Output Only] The configuration of bundled local SSD for the machine type. "defaultInterface": "A String", # The default disk interface if the interface is not specified. "partitionCount": 42, # The number of partitions. diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html index 3f14a8baa02..139c46ae7ec 100644 --- a/docs/dyn/compute_beta.regionBackendServices.html +++ b/docs/dyn/compute_beta.regionBackendServices.html @@ -369,6 +369,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -743,6 +745,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -1097,6 +1101,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -1350,6 +1356,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -1619,6 +1627,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. @@ -2329,6 +2339,8 @@

Method Details

"description": "A String", # An optional description of this resource. Provide this property when you create the resource. "edgeSecurityPolicy": "A String", # [Output Only] The resource URL for the edge security policy associated with this backend service. "enableCDN": True or False, # If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. + "externalManagedMigrationState": "A String", # Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + "externalManagedMigrationTestingPercentage": 3.14, # Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. "failoverPolicy": { # For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). # Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). "disableConnectionDrainOnFailover": True or False, # This can be set to true only if the protocol is TCP. The default is false. "dropTrafficIfUnhealthy": True or False, # If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). The default is false. diff --git a/docs/dyn/compute_beta.vpnTunnels.html b/docs/dyn/compute_beta.vpnTunnels.html index c234a0d12fe..5a04ab4747c 100644 --- a/docs/dyn/compute_beta.vpnTunnels.html +++ b/docs/dyn/compute_beta.vpnTunnels.html @@ -142,16 +142,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -159,7 +159,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. }, @@ -366,16 +366,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -383,7 +383,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. } @@ -410,16 +410,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -427,7 +427,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. } @@ -583,16 +583,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -600,7 +600,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. }, diff --git a/docs/dyn/compute_v1.futureReservations.html b/docs/dyn/compute_v1.futureReservations.html index add41dca219..0773a8ea130 100644 --- a/docs/dyn/compute_v1.futureReservations.html +++ b/docs/dyn/compute_v1.futureReservations.html @@ -156,7 +156,6 @@

Method Details

}, "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -594,7 +593,6 @@

Method Details

}, "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -727,7 +725,6 @@

Method Details

}, "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -990,7 +987,6 @@

Method Details

}, "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. @@ -1156,7 +1152,6 @@

Method Details

}, "shareType": "A String", # Type of sharing for this shared-reservation }, - "specificReservationRequired": True or False, # Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. "guestAccelerators": [ # Specifies accelerator type and count. diff --git a/docs/dyn/compute_v1.machineTypes.html b/docs/dyn/compute_v1.machineTypes.html index 19d382681a3..d3ab486c070 100644 --- a/docs/dyn/compute_v1.machineTypes.html +++ b/docs/dyn/compute_v1.machineTypes.html @@ -126,6 +126,7 @@

Method Details

"guestAcceleratorType": "A String", # The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4. }, ], + "architecture": "A String", # [Output Only] The architecture of the machine type. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable. "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. @@ -226,6 +227,7 @@

Method Details

"guestAcceleratorType": "A String", # The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4. }, ], + "architecture": "A String", # [Output Only] The architecture of the machine type. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable. "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. @@ -284,6 +286,7 @@

Method Details

"guestAcceleratorType": "A String", # The accelerator type resource name, not a full URL, e.g. nvidia-tesla-t4. }, ], + "architecture": "A String", # [Output Only] The architecture of the machine type. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type. Only applicable if the machine type is unavailable. "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. diff --git a/docs/dyn/compute_v1.vpnTunnels.html b/docs/dyn/compute_v1.vpnTunnels.html index 43f8a64110b..d744b697dd6 100644 --- a/docs/dyn/compute_v1.vpnTunnels.html +++ b/docs/dyn/compute_v1.vpnTunnels.html @@ -139,16 +139,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -156,7 +156,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. }, @@ -363,16 +363,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -380,7 +380,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. } @@ -407,16 +407,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -424,7 +424,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. } @@ -580,16 +580,16 @@

Method Details

"labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. "a_key": "A String", }, - "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + "localTrafficSelector": [ # Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "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. "peerExternalGateway": "A String", # URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. "peerExternalGatewayInterface": 42, # The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. "peerGcpGateway": "A String", # URL of the peer side HA VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer Google Cloud VPN gateway. - "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. + "peerIp": "A String", # IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. "region": "A String", # [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + "remoteTrafficSelector": [ # Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. "A String", ], "router": "A String", # URL of the router resource to be used for dynamic routing. @@ -597,7 +597,7 @@

Method Details

"sharedSecret": "A String", # Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. "sharedSecretHash": "A String", # Hash of the shared secret. "status": "A String", # [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. - "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + "targetVpnGateway": "A String", # URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. "vpnGateway": "A String", # URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. "vpnGatewayInterface": 42, # The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. }, diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 9f16d1ae651..df05cac4705 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -483,6 +483,7 @@

Method Details

"updateTime": "A String", # Output only. Timestamp when the webhook was last updated. }, }, + "host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS. "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -544,6 +545,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. } @@ -960,6 +962,7 @@

Method Details

"updateTime": "A String", # Output only. Timestamp when the webhook was last updated. }, }, + "host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS. "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -1021,6 +1024,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. } @@ -1456,6 +1460,7 @@

Method Details

"updateTime": "A String", # Output only. Timestamp when the webhook was last updated. }, }, + "host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS. "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -1517,6 +1522,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. }, ], @@ -1906,6 +1912,7 @@

Method Details

"updateTime": "A String", # Output only. Timestamp when the webhook was last updated. }, }, + "host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS. "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -1967,6 +1974,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. } @@ -2489,6 +2497,7 @@

Method Details

"updateTime": "A String", # Output only. Timestamp when the webhook was last updated. }, }, + "host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS. "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -2550,6 +2559,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. }, "entitySchema": { # Schema of a runtime entity. # Output only. Schema of a runtime entity. diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html index 7d6045b6c61..94a8ee6cdc0 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -190,6 +190,7 @@

Method Details

], "description": "A String", # Connector specific description for an authentication template. "displayName": "A String", # Display name for authentication template. + "isDefault": True or False, # Whether the auth config is the default one. }, ], "authOverrideEnabled": True or False, # Output only. Flag to mark the dynamic auth override. @@ -454,6 +455,7 @@

Method Details

], "description": "A String", # Connector specific description for an authentication template. "displayName": "A String", # Display name for authentication template. + "isDefault": True or False, # Whether the auth config is the default one. }, ], "autoRefresh": True or False, # Auto refresh to extend webhook life. @@ -599,6 +601,7 @@

Method Details

], "description": "A String", # Connector specific description for an authentication template. "displayName": "A String", # Display name for authentication template. + "isDefault": True or False, # Whether the auth config is the default one. }, ], "proxyDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Proxy destination config template. @@ -697,6 +700,7 @@

Method Details

}, ], }, + "isAsyncOperationsSupported": True or False, # Output only. Is async operations supported. "isCustomActionsSupported": True or False, # Output only. Is custom actions supported. "isCustomEntitiesSupported": True or False, # Output only. Is custom entities supported. "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -929,6 +933,7 @@

Method Details

], "description": "A String", # Connector specific description for an authentication template. "displayName": "A String", # Display name for authentication template. + "isDefault": True or False, # Whether the auth config is the default one. }, ], "authOverrideEnabled": True or False, # Output only. Flag to mark the dynamic auth override. @@ -1193,6 +1198,7 @@

Method Details

], "description": "A String", # Connector specific description for an authentication template. "displayName": "A String", # Display name for authentication template. + "isDefault": True or False, # Whether the auth config is the default one. }, ], "autoRefresh": True or False, # Auto refresh to extend webhook life. @@ -1338,6 +1344,7 @@

Method Details

], "description": "A String", # Connector specific description for an authentication template. "displayName": "A String", # Display name for authentication template. + "isDefault": True or False, # Whether the auth config is the default one. }, ], "proxyDestinationConfig": { # DestinationConfigTemplate defines required destinations supported by the Connector. # Proxy destination config template. @@ -1436,6 +1443,7 @@

Method Details

}, ], }, + "isAsyncOperationsSupported": True or False, # Output only. Is async operations supported. "isCustomActionsSupported": True or False, # Output only. Is custom actions supported. "isCustomEntitiesSupported": True or False, # Output only. Is custom entities supported. "labels": { # Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index 9d8c5a49b69..b2d7824346c 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -735,6 +735,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -964,6 +967,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1116,6 +1122,9 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -1757,6 +1766,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1986,6 +1998,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2138,6 +2153,9 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -2682,6 +2700,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2911,6 +2932,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3063,6 +3087,9 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -4298,6 +4325,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index ea57bac531b..0ecf7f1cafa 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -305,6 +305,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -722,6 +725,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1005,6 +1011,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1577,6 +1586,9 @@

Method Details

"a_key": "A String", }, }, + "storagePools": [ # List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools. + "A String", + ], "tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. "tags": [ # List of network tags. "A String", diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 1c0a8dc274a..718a8a48aa2 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -823,6 +823,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1052,6 +1055,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1204,6 +1210,9 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -1845,6 +1854,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2074,6 +2086,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2226,6 +2241,9 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -2814,6 +2832,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3043,6 +3064,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3195,6 +3219,9 @@

Method Details

}, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. + "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -4325,6 +4352,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config. + "enabled": True or False, # Enable/Disable Secret Manager Config. + }, "desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index f31b1d958b5..1ca86a702a4 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -370,6 +370,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -787,6 +790,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1070,6 +1076,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1567,6 +1576,9 @@

Method Details

"a_key": "A String", }, }, + "storagePools": [ # List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools. + "A String", + ], "tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. "tags": [ # List of network tags. "A String", diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index c7082c40e6e..40b6ef667ad 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -780,6 +780,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1031,6 +1034,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1198,7 +1204,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. @@ -1899,6 +1905,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2150,6 +2159,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2317,7 +2329,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. @@ -2921,6 +2933,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3172,6 +3187,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3339,7 +3357,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. @@ -4633,7 +4651,7 @@

Method Details

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, "desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index d84299fdb5b..03e8e5b6ba7 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -318,6 +318,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -752,6 +755,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1052,6 +1058,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1630,6 +1639,9 @@

Method Details

"a_key": "A String", }, }, + "storagePools": [ # List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools. + "A String", + ], "tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. "tags": [ # List of network tags. "A String", diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 28e7f0faef5..f2d0b95fd3c 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -875,6 +875,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1126,6 +1129,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1293,7 +1299,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. @@ -1994,6 +2000,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2245,6 +2254,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -2412,7 +2424,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. @@ -3060,6 +3072,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3311,6 +3326,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -3478,7 +3496,7 @@

Method Details

"satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. @@ -4660,7 +4678,7 @@

Method Details

"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, "desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config. - "enabled": True or False, # Whether the cluster is configured to use secret manager CSI component. + "enabled": True or False, # Enable/Disable Secret Manager Config. }, "desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index f4436a1ca2c..8a3ca881ae0 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -383,6 +383,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -817,6 +820,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1117,6 +1123,9 @@

Method Details

], }, "spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. + "storagePools": [ # List of Storage Pools where boot disks are provisioned. + "A String", + ], "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. "A String", ], @@ -1620,6 +1629,9 @@

Method Details

"a_key": "A String", }, }, + "storagePools": [ # List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools. + "A String", + ], "tags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. "tags": [ # List of network tags. "A String", diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html index e69819595be..4fd31ac9e76 100644 --- a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html +++ b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html @@ -102,6 +102,7 @@

Method Details

{ # Request to lease WorkItems. "currentWorkerTime": "A String", # The current timestamp at the worker. "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. + "projectNumber": "A String", # Optional. The project number of the project this worker belongs to. "requestedLeaseDuration": "A String", # The initial lease period. "unifiedWorkerRequest": { # Untranslated bag-of-bytes WorkRequest from UnifiedWorker. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -712,6 +713,7 @@

Method Details

{ # Request to report the status of WorkItems. "currentWorkerTime": "A String", # The current timestamp at the worker. "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. + "projectNumber": "A String", # Optional. The project number of the project which owns the WorkItem's job. "unifiedWorkerRequest": { # Untranslated bag-of-bytes WorkProgressUpdateRequest from UnifiedWorker. "a_key": "", # Properties of the object. Contains field @type with type URL. }, diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html index 512c7fdb2b9..949b8d7ae45 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html @@ -103,6 +103,7 @@

Method Details

{ # Request to lease WorkItems. "currentWorkerTime": "A String", # The current timestamp at the worker. "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. + "projectNumber": "A String", # Optional. The project number of the project this worker belongs to. "requestedLeaseDuration": "A String", # The initial lease period. "unifiedWorkerRequest": { # Untranslated bag-of-bytes WorkRequest from UnifiedWorker. "a_key": "", # Properties of the object. Contains field @type with type URL. @@ -714,6 +715,7 @@

Method Details

{ # Request to report the status of WorkItems. "currentWorkerTime": "A String", # The current timestamp at the worker. "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job. + "projectNumber": "A String", # Optional. The project number of the project which owns the WorkItem's job. "unifiedWorkerRequest": { # Untranslated bag-of-bytes WorkProgressUpdateRequest from UnifiedWorker. "a_key": "", # Properties of the object. Contains field @type with type URL. }, diff --git a/docs/dyn/dataflow_v1b3.projects.locations.templates.html b/docs/dyn/dataflow_v1b3.projects.locations.templates.html index 3df8de3d534..d2d80449ce4 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.templates.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.templates.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

create(projectId, location, body=None, x__xgafv=None)

-

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

+

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`.

get(projectId, location, gcsPath=None, view=None, x__xgafv=None)

-

Get the template associated with a template.

+

Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.

launch(projectId, location, body=None, dynamicTemplate_gcsPath=None, dynamicTemplate_stagingLocation=None, gcsPath=None, validateOnly=None, x__xgafv=None)

-

Launch a template.

+

Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.

Method Details

close() @@ -94,7 +94,7 @@

Method Details

create(projectId, location, body=None, x__xgafv=None) -
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
+  
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`.
 
 Args:
   projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
@@ -475,7 +475,7 @@ 

Method Details

get(projectId, location, gcsPath=None, view=None, x__xgafv=None) -
Get the template associated with a template.
+  
Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.
 
 Args:
   projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
@@ -580,7 +580,7 @@ 

Method Details

launch(projectId, location, body=None, dynamicTemplate_gcsPath=None, dynamicTemplate_stagingLocation=None, gcsPath=None, validateOnly=None, x__xgafv=None) -
Launch a template.
+  
Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.
 
 Args:
   projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
diff --git a/docs/dyn/dataflow_v1b3.projects.templates.html b/docs/dyn/dataflow_v1b3.projects.templates.html
index eea83967cfd..560b9182014 100644
--- a/docs/dyn/dataflow_v1b3.projects.templates.html
+++ b/docs/dyn/dataflow_v1b3.projects.templates.html
@@ -79,13 +79,13 @@ 

Instance Methods

Close httplib2 connections.

create(projectId, body=None, x__xgafv=None)

-

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.

+

Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`.

get(projectId, gcsPath=None, location=None, view=None, x__xgafv=None)

-

Get the template associated with a template.

+

Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.

launch(projectId, body=None, dynamicTemplate_gcsPath=None, dynamicTemplate_stagingLocation=None, gcsPath=None, location=None, validateOnly=None, x__xgafv=None)

-

Launch a template.

+

Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.

Method Details

close() @@ -94,7 +94,7 @@

Method Details

create(projectId, body=None, x__xgafv=None) -
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
+  
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`.
 
 Args:
   projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
@@ -474,7 +474,7 @@ 

Method Details

get(projectId, gcsPath=None, location=None, view=None, x__xgafv=None) -
Get the template associated with a template.
+  
Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.
 
 Args:
   projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
@@ -579,7 +579,7 @@ 

Method Details

launch(projectId, body=None, dynamicTemplate_gcsPath=None, dynamicTemplate_stagingLocation=None, gcsPath=None, location=None, validateOnly=None, x__xgafv=None) -
Launch a template.
+  
Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.
 
 Args:
   projectId: string, Required. The ID of the Cloud Platform project that the job belongs to. (required)
diff --git a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html
index 791b835b1dc..26cca9285a9 100644
--- a/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html
+++ b/docs/dyn/datamigration_v1.projects.locations.connectionProfiles.html
@@ -237,6 +237,20 @@ 

Method Details

"username": "A String", # Required. Username for the SSH tunnel. }, "host": "A String", # Required. The IP or hostname of the source Oracle database. + "oracleAsmConfig": { # Configuration for Oracle Automatic Storage Management (ASM) connection. # Optional. Configuration for Oracle ASM connection. + "asmService": "A String", # Required. ASM service name for the Oracle ASM connection. + "hostname": "A String", # Required. Hostname for the Oracle ASM connection. + "password": "A String", # Required. Input only. Password for the Oracle ASM connection. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. Port for the Oracle ASM connection. + "ssl": { # SSL configuration information. # Optional. SSL configuration for the Oracle connection. + "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. + "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. + "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. + "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. + }, + "username": "A String", # Required. Username for the Oracle ASM connection. + }, "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. "port": 42, # Required. The network port of the source Oracle database. @@ -514,6 +528,20 @@

Method Details

"username": "A String", # Required. Username for the SSH tunnel. }, "host": "A String", # Required. The IP or hostname of the source Oracle database. + "oracleAsmConfig": { # Configuration for Oracle Automatic Storage Management (ASM) connection. # Optional. Configuration for Oracle ASM connection. + "asmService": "A String", # Required. ASM service name for the Oracle ASM connection. + "hostname": "A String", # Required. Hostname for the Oracle ASM connection. + "password": "A String", # Required. Input only. Password for the Oracle ASM connection. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. Port for the Oracle ASM connection. + "ssl": { # SSL configuration information. # Optional. SSL configuration for the Oracle connection. + "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. + "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. + "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. + "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. + }, + "username": "A String", # Required. Username for the Oracle ASM connection. + }, "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. "port": 42, # Required. The network port of the source Oracle database. @@ -776,6 +804,20 @@

Method Details

"username": "A String", # Required. Username for the SSH tunnel. }, "host": "A String", # Required. The IP or hostname of the source Oracle database. + "oracleAsmConfig": { # Configuration for Oracle Automatic Storage Management (ASM) connection. # Optional. Configuration for Oracle ASM connection. + "asmService": "A String", # Required. ASM service name for the Oracle ASM connection. + "hostname": "A String", # Required. Hostname for the Oracle ASM connection. + "password": "A String", # Required. Input only. Password for the Oracle ASM connection. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. Port for the Oracle ASM connection. + "ssl": { # SSL configuration information. # Optional. SSL configuration for the Oracle connection. + "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. + "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. + "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. + "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. + }, + "username": "A String", # Required. Username for the Oracle ASM connection. + }, "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. "port": 42, # Required. The network port of the source Oracle database. @@ -999,6 +1041,20 @@

Method Details

"username": "A String", # Required. Username for the SSH tunnel. }, "host": "A String", # Required. The IP or hostname of the source Oracle database. + "oracleAsmConfig": { # Configuration for Oracle Automatic Storage Management (ASM) connection. # Optional. Configuration for Oracle ASM connection. + "asmService": "A String", # Required. ASM service name for the Oracle ASM connection. + "hostname": "A String", # Required. Hostname for the Oracle ASM connection. + "password": "A String", # Required. Input only. Password for the Oracle ASM connection. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. Port for the Oracle ASM connection. + "ssl": { # SSL configuration information. # Optional. SSL configuration for the Oracle connection. + "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. + "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. + "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. + "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. + }, + "username": "A String", # Required. Username for the Oracle ASM connection. + }, "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. "port": 42, # Required. The network port of the source Oracle database. diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index d043d2c775d..34332a9c2a7 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -74,6 +74,11 @@

Database Migration API . projects . locations . migrationJobs

Instance Methods

+

+ objects() +

+

Returns the objects Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.objects.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.objects.html new file mode 100644 index 00000000000..6efe95f0962 --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.objects.html @@ -0,0 +1,258 @@ + + + +

Database Migration API . projects . locations . migrationJobs . objects

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

+ testIamPermissions(resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) +
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+          "A String",
+        ],
+        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
+        "A String",
+      ],
+      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ testIamPermissions(resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+    "A 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 `TestIamPermissions` method.
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html index 12982ac33cf..94d7b77a65d 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html @@ -107,7 +107,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html index 4fe26c7437b..8a67719a917 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html @@ -107,7 +107,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html index dfcc6028190..93ed2e8771e 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html @@ -357,7 +357,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 63364124ef6..9c690273b4f 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -357,7 +357,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html index fb3d6d52399..cf2b55f9eff 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html @@ -142,7 +142,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -214,7 +214,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -299,7 +299,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index ebd80c14a4d..17f8a035550 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -1666,7 +1666,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4611,7 +4611,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html index 6064a53909e..69e50f44169 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html @@ -107,7 +107,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html index e5c821c7e3b..0c43f8d87c5 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html @@ -142,7 +142,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -214,7 +214,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -299,7 +299,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index df5b76d5f57..511c4178fab 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -1666,7 +1666,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4611,7 +4611,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html index 7daef889efe..fd5a6e5bbf5 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html @@ -107,7 +107,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index 821c00e084f..f63805e25c0 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -332,7 +332,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -389,7 +389,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 758c6580e6a..10db99ed984 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -332,7 +332,7 @@

Method Details

"sipUri": "A String", # Transfer the call to a SIP endpoint. }, "text": { # The text response message. # Returns a text response. - "text": [ # A collection of text responses. + "text": [ # A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -389,7 +389,7 @@

Method Details

"languageCode": "A String", # Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "text": "A String", # Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters for virtual agent interactions. }, - "sessionId": "A String", # Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. + "sessionId": "A String", # Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html index 8333410e355..be30e1e011d 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -194,6 +194,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -390,7 +401,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -447,7 +458,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -546,7 +557,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -603,7 +614,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -729,7 +740,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -786,7 +797,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -885,7 +896,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -942,7 +953,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1053,7 +1064,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1110,7 +1121,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1215,7 +1226,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1272,7 +1283,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1464,7 +1475,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1619,6 +1630,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -1831,7 +1853,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1888,7 +1910,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1987,7 +2009,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2044,7 +2066,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2170,7 +2192,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2227,7 +2249,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2326,7 +2348,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2383,7 +2405,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2494,7 +2516,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2551,7 +2573,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2656,7 +2678,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2713,7 +2735,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2905,7 +2927,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3019,6 +3041,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -3170,7 +3203,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3227,7 +3260,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3326,7 +3359,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3383,7 +3416,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3509,7 +3542,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3566,7 +3599,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3665,7 +3698,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3722,7 +3755,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3833,7 +3866,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3890,7 +3923,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3995,7 +4028,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4052,7 +4085,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4213,6 +4246,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -4409,7 +4453,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4466,7 +4510,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4565,7 +4609,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4622,7 +4666,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4748,7 +4792,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4805,7 +4849,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4904,7 +4948,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4961,7 +5005,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5072,7 +5116,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5129,7 +5173,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5234,7 +5278,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5291,7 +5335,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5483,7 +5527,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index 73496251d3d..a9824b3c31a 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -251,7 +251,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -308,7 +308,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -412,7 +412,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -469,7 +469,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -586,7 +586,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -643,7 +643,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -783,7 +783,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -840,7 +840,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -944,7 +944,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1001,7 +1001,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1118,7 +1118,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1175,7 +1175,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1384,7 +1384,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1441,7 +1441,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1545,7 +1545,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1602,7 +1602,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1719,7 +1719,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1776,7 +1776,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2011,7 +2011,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2068,7 +2068,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2172,7 +2172,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2229,7 +2229,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2346,7 +2346,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2403,7 +2403,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2561,7 +2561,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2618,7 +2618,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2722,7 +2722,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2779,7 +2779,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2896,7 +2896,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2953,7 +2953,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3094,7 +3094,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3151,7 +3151,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3255,7 +3255,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3312,7 +3312,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3429,7 +3429,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3486,7 +3486,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html index c7686ac4111..6264414706f 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html @@ -214,7 +214,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -271,7 +271,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -370,7 +370,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -427,7 +427,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -553,7 +553,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -610,7 +610,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -709,7 +709,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -766,7 +766,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -877,7 +877,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -934,7 +934,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1039,7 +1039,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1096,7 +1096,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1229,7 +1229,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1286,7 +1286,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1385,7 +1385,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1442,7 +1442,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1568,7 +1568,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1625,7 +1625,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1724,7 +1724,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1781,7 +1781,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1892,7 +1892,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1949,7 +1949,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2054,7 +2054,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2111,7 +2111,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2270,7 +2270,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2327,7 +2327,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2426,7 +2426,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2483,7 +2483,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2609,7 +2609,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2666,7 +2666,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2765,7 +2765,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2822,7 +2822,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2933,7 +2933,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2990,7 +2990,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3095,7 +3095,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3152,7 +3152,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3297,7 +3297,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3354,7 +3354,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3453,7 +3453,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3510,7 +3510,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3636,7 +3636,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3693,7 +3693,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3792,7 +3792,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3849,7 +3849,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3960,7 +3960,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4017,7 +4017,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4122,7 +4122,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4179,7 +4179,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4329,7 +4329,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4386,7 +4386,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4485,7 +4485,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4542,7 +4542,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4668,7 +4668,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4725,7 +4725,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4824,7 +4824,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4881,7 +4881,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4992,7 +4992,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5049,7 +5049,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5154,7 +5154,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5211,7 +5211,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5345,7 +5345,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5402,7 +5402,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5501,7 +5501,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5558,7 +5558,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5684,7 +5684,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5741,7 +5741,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5840,7 +5840,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5897,7 +5897,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6008,7 +6008,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6065,7 +6065,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6170,7 +6170,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6227,7 +6227,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html index 3e33d4a6233..bca6aa82c10 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html @@ -197,7 +197,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -254,7 +254,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -370,7 +370,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -427,7 +427,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -569,7 +569,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -626,7 +626,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -754,7 +754,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -811,7 +811,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -944,7 +944,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1001,7 +1001,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1118,7 +1118,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1175,7 +1175,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index bd182f60ae2..12586453e55 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -197,6 +197,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -393,7 +404,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -450,7 +461,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -549,7 +560,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -606,7 +617,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -732,7 +743,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -789,7 +800,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -888,7 +899,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -945,7 +956,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1056,7 +1067,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1113,7 +1124,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1218,7 +1229,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1275,7 +1286,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1467,7 +1478,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1622,6 +1633,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -1834,7 +1856,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1891,7 +1913,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1990,7 +2012,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2047,7 +2069,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2173,7 +2195,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2230,7 +2252,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2329,7 +2351,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2386,7 +2408,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2497,7 +2519,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2554,7 +2576,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2659,7 +2681,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2716,7 +2738,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2908,7 +2930,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3022,6 +3044,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -3173,7 +3206,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3230,7 +3263,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3329,7 +3362,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3386,7 +3419,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3512,7 +3545,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3569,7 +3602,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3668,7 +3701,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3725,7 +3758,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3836,7 +3869,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3893,7 +3926,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3998,7 +4031,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4055,7 +4088,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4216,6 +4249,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -4412,7 +4456,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4469,7 +4513,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4568,7 +4612,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4625,7 +4669,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4751,7 +4795,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4808,7 +4852,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4907,7 +4951,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4964,7 +5008,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5075,7 +5119,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5132,7 +5176,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5237,7 +5281,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5294,7 +5338,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5486,7 +5530,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 7d789982dab..8276055002b 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -311,7 +311,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -368,7 +368,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -473,7 +473,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -530,7 +530,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -639,7 +639,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -696,7 +696,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -826,7 +826,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -883,7 +883,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -987,7 +987,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1044,7 +1044,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1161,7 +1161,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1218,7 +1218,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1341,7 +1341,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1398,7 +1398,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1497,7 +1497,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1554,7 +1554,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1680,7 +1680,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1737,7 +1737,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1836,7 +1836,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1893,7 +1893,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2004,7 +2004,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2061,7 +2061,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2166,7 +2166,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2223,7 +2223,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2355,7 +2355,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2412,7 +2412,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2516,7 +2516,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2573,7 +2573,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2690,7 +2690,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2747,7 +2747,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2870,7 +2870,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2927,7 +2927,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3026,7 +3026,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3083,7 +3083,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3209,7 +3209,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3266,7 +3266,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3365,7 +3365,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3422,7 +3422,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3533,7 +3533,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3590,7 +3590,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3695,7 +3695,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3752,7 +3752,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3855,7 +3855,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3912,7 +3912,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4102,7 +4102,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4159,7 +4159,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4258,7 +4258,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4315,7 +4315,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4441,7 +4441,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4498,7 +4498,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4597,7 +4597,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4654,7 +4654,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4765,7 +4765,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4822,7 +4822,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4927,7 +4927,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4984,7 +4984,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5027,7 +5027,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5224,7 +5224,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5281,7 +5281,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5380,7 +5380,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5437,7 +5437,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5563,7 +5563,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5620,7 +5620,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5719,7 +5719,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5776,7 +5776,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5887,7 +5887,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5944,7 +5944,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6049,7 +6049,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6106,7 +6106,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6149,7 +6149,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6357,7 +6357,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6414,7 +6414,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6513,7 +6513,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6570,7 +6570,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6696,7 +6696,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6753,7 +6753,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6852,7 +6852,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6909,7 +6909,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7020,7 +7020,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7077,7 +7077,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7182,7 +7182,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7239,7 +7239,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7282,7 +7282,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7479,7 +7479,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7536,7 +7536,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7635,7 +7635,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7692,7 +7692,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7818,7 +7818,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7875,7 +7875,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7974,7 +7974,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8031,7 +8031,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8142,7 +8142,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8199,7 +8199,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8304,7 +8304,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8361,7 +8361,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8404,7 +8404,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8663,7 +8663,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8720,7 +8720,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8819,7 +8819,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8876,7 +8876,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9002,7 +9002,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9059,7 +9059,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9158,7 +9158,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9215,7 +9215,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9326,7 +9326,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9383,7 +9383,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9488,7 +9488,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9545,7 +9545,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9588,7 +9588,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9785,7 +9785,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9842,7 +9842,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9941,7 +9941,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9998,7 +9998,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10124,7 +10124,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10181,7 +10181,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10280,7 +10280,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10337,7 +10337,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10448,7 +10448,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10505,7 +10505,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10610,7 +10610,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10667,7 +10667,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10710,7 +10710,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10978,7 +10978,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11035,7 +11035,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11134,7 +11134,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11191,7 +11191,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11317,7 +11317,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11374,7 +11374,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11473,7 +11473,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11530,7 +11530,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11641,7 +11641,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11698,7 +11698,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11803,7 +11803,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11860,7 +11860,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11903,7 +11903,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12100,7 +12100,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12157,7 +12157,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12256,7 +12256,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12313,7 +12313,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12439,7 +12439,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12496,7 +12496,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12595,7 +12595,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12652,7 +12652,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12763,7 +12763,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12820,7 +12820,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12925,7 +12925,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12982,7 +12982,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13025,7 +13025,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13251,7 +13251,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13308,7 +13308,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13407,7 +13407,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13464,7 +13464,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13590,7 +13590,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13647,7 +13647,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13746,7 +13746,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13803,7 +13803,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13914,7 +13914,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13971,7 +13971,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14076,7 +14076,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14133,7 +14133,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14176,7 +14176,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14373,7 +14373,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14430,7 +14430,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14529,7 +14529,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14586,7 +14586,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14712,7 +14712,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14769,7 +14769,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14868,7 +14868,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14925,7 +14925,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15036,7 +15036,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15093,7 +15093,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15198,7 +15198,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15255,7 +15255,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15298,7 +15298,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15507,7 +15507,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15564,7 +15564,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15663,7 +15663,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15720,7 +15720,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15846,7 +15846,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15903,7 +15903,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16002,7 +16002,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16059,7 +16059,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16170,7 +16170,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16227,7 +16227,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16332,7 +16332,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16389,7 +16389,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16432,7 +16432,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16629,7 +16629,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16686,7 +16686,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16785,7 +16785,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16842,7 +16842,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16968,7 +16968,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17025,7 +17025,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17124,7 +17124,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17181,7 +17181,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17292,7 +17292,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17349,7 +17349,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17454,7 +17454,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17511,7 +17511,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17554,7 +17554,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html index eac472e3000..a40007cff07 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html @@ -256,7 +256,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -313,7 +313,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -412,7 +412,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -469,7 +469,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -595,7 +595,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -652,7 +652,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -751,7 +751,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -808,7 +808,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -919,7 +919,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -976,7 +976,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1081,7 +1081,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1138,7 +1138,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1181,7 +1181,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1396,7 +1396,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1453,7 +1453,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1552,7 +1552,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1609,7 +1609,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1735,7 +1735,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1792,7 +1792,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1891,7 +1891,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1948,7 +1948,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2059,7 +2059,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2116,7 +2116,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2221,7 +2221,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2278,7 +2278,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2321,7 +2321,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html b/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html index 400c11d484b..5ec0c50810b 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html @@ -197,7 +197,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -254,7 +254,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -370,7 +370,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -427,7 +427,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -569,7 +569,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -626,7 +626,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -754,7 +754,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -811,7 +811,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -944,7 +944,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1001,7 +1001,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1118,7 +1118,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1175,7 +1175,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index 3127d566d71..e2ff0ce2c80 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -326,7 +326,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -389,7 +389,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -499,7 +499,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -562,7 +562,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -685,7 +685,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -748,7 +748,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -971,7 +971,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1034,7 +1034,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1144,7 +1144,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1207,7 +1207,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1330,7 +1330,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1393,7 +1393,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1522,7 +1522,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1585,7 +1585,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1690,7 +1690,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1753,7 +1753,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1885,7 +1885,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1948,7 +1948,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2053,7 +2053,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2116,7 +2116,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2233,7 +2233,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2296,7 +2296,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2407,7 +2407,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2470,7 +2470,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2741,7 +2741,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2895,6 +2895,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -3090,7 +3101,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3153,7 +3164,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3263,7 +3274,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3326,7 +3337,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3449,7 +3460,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3512,7 +3523,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3641,7 +3652,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3704,7 +3715,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3809,7 +3820,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3872,7 +3883,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4004,7 +4015,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4067,7 +4078,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4172,7 +4183,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4235,7 +4246,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4352,7 +4363,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4415,7 +4426,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4526,7 +4537,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4589,7 +4600,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4860,7 +4871,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5047,7 +5058,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5110,7 +5121,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5215,7 +5226,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5278,7 +5289,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5410,7 +5421,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5473,7 +5484,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5578,7 +5589,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5641,7 +5652,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5758,7 +5769,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5821,7 +5832,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5932,7 +5943,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5995,7 +6006,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6245,7 +6256,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6308,7 +6319,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6418,7 +6429,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6481,7 +6492,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6604,7 +6615,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6667,7 +6678,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6890,7 +6901,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6953,7 +6964,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7063,7 +7074,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7126,7 +7137,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7249,7 +7260,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7312,7 +7323,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7441,7 +7452,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7504,7 +7515,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7609,7 +7620,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7672,7 +7683,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7804,7 +7815,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7867,7 +7878,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7972,7 +7983,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8035,7 +8046,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8152,7 +8163,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8215,7 +8226,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8326,7 +8337,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8389,7 +8400,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8660,7 +8671,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8814,6 +8825,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -9009,7 +9031,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9072,7 +9094,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9182,7 +9204,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9245,7 +9267,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9368,7 +9390,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9431,7 +9453,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9560,7 +9582,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9623,7 +9645,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9728,7 +9750,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9791,7 +9813,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9923,7 +9945,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9986,7 +10008,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10091,7 +10113,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10154,7 +10176,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10271,7 +10293,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10334,7 +10356,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10445,7 +10467,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10508,7 +10530,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10779,7 +10801,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10966,7 +10988,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11029,7 +11051,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11134,7 +11156,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11197,7 +11219,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11329,7 +11351,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11392,7 +11414,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11497,7 +11519,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11560,7 +11582,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11677,7 +11699,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11740,7 +11762,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11851,7 +11873,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11914,7 +11936,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html index 149d32198a6..7beaef84a09 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -209,6 +209,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -412,7 +423,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -475,7 +486,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -585,7 +596,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -648,7 +659,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -771,7 +782,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -834,7 +845,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -963,7 +974,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1026,7 +1037,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1131,7 +1142,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1194,7 +1205,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1326,7 +1337,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1389,7 +1400,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1494,7 +1505,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1557,7 +1568,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1674,7 +1685,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1737,7 +1748,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1848,7 +1859,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1911,7 +1922,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2182,7 +2193,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2371,6 +2382,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -2589,7 +2611,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2652,7 +2674,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2762,7 +2784,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2825,7 +2847,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2948,7 +2970,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3011,7 +3033,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3140,7 +3162,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3203,7 +3225,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3308,7 +3330,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3371,7 +3393,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3503,7 +3525,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3566,7 +3588,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3671,7 +3693,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3734,7 +3756,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3851,7 +3873,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3914,7 +3936,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4025,7 +4047,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4088,7 +4110,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4359,7 +4381,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4507,6 +4529,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -4657,7 +4690,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4720,7 +4753,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4825,7 +4858,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4888,7 +4921,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5020,7 +5053,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5083,7 +5116,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5188,7 +5221,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5251,7 +5284,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5368,7 +5401,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5431,7 +5464,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5542,7 +5575,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5605,7 +5638,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5788,6 +5821,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -5991,7 +6035,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6054,7 +6098,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6164,7 +6208,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6227,7 +6271,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6350,7 +6394,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6413,7 +6457,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6542,7 +6586,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6605,7 +6649,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6710,7 +6754,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6773,7 +6817,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6905,7 +6949,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6968,7 +7012,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7073,7 +7117,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7136,7 +7180,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7253,7 +7297,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7316,7 +7360,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7427,7 +7471,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7490,7 +7534,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7761,7 +7805,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index b65a70eaa10..4577ff41a96 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -250,7 +250,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -313,7 +313,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -423,7 +423,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -486,7 +486,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -609,7 +609,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -672,7 +672,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -818,7 +818,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -881,7 +881,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -991,7 +991,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1054,7 +1054,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1177,7 +1177,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1240,7 +1240,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1455,7 +1455,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1518,7 +1518,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1628,7 +1628,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1691,7 +1691,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1814,7 +1814,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1877,7 +1877,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2118,7 +2118,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2181,7 +2181,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2291,7 +2291,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2354,7 +2354,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2477,7 +2477,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2540,7 +2540,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2704,7 +2704,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2767,7 +2767,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2877,7 +2877,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2940,7 +2940,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3063,7 +3063,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3126,7 +3126,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3273,7 +3273,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3336,7 +3336,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3446,7 +3446,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3509,7 +3509,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3632,7 +3632,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3695,7 +3695,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html index 28efc3df3fc..d29f9cbe1e7 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html @@ -213,7 +213,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -276,7 +276,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -381,7 +381,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -444,7 +444,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -576,7 +576,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -639,7 +639,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -744,7 +744,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -807,7 +807,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -924,7 +924,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -987,7 +987,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1098,7 +1098,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1161,7 +1161,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1300,7 +1300,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1363,7 +1363,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1468,7 +1468,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1531,7 +1531,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1663,7 +1663,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1726,7 +1726,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1831,7 +1831,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1894,7 +1894,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2011,7 +2011,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2074,7 +2074,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2185,7 +2185,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2248,7 +2248,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2413,7 +2413,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2476,7 +2476,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2581,7 +2581,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2644,7 +2644,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2776,7 +2776,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2839,7 +2839,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2944,7 +2944,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3007,7 +3007,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3124,7 +3124,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3187,7 +3187,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3298,7 +3298,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3361,7 +3361,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3512,7 +3512,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3575,7 +3575,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3680,7 +3680,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3743,7 +3743,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3875,7 +3875,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3938,7 +3938,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4043,7 +4043,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4106,7 +4106,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4223,7 +4223,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4286,7 +4286,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4397,7 +4397,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4460,7 +4460,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4616,7 +4616,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4679,7 +4679,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4784,7 +4784,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4847,7 +4847,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4979,7 +4979,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5042,7 +5042,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5147,7 +5147,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5210,7 +5210,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5327,7 +5327,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5390,7 +5390,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5501,7 +5501,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5564,7 +5564,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5704,7 +5704,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5767,7 +5767,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5872,7 +5872,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5935,7 +5935,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6067,7 +6067,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6130,7 +6130,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6235,7 +6235,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6298,7 +6298,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6415,7 +6415,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6478,7 +6478,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6589,7 +6589,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6652,7 +6652,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html index 7efbb57a4da..d79e5536d1c 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html @@ -196,7 +196,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -259,7 +259,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -381,7 +381,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -444,7 +444,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -592,7 +592,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -655,7 +655,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -789,7 +789,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -852,7 +852,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -991,7 +991,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1054,7 +1054,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1177,7 +1177,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1240,7 +1240,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index 5ebee4c71f6..83e2330a213 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -212,6 +212,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -415,7 +426,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -478,7 +489,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -588,7 +599,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -651,7 +662,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -774,7 +785,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -837,7 +848,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -966,7 +977,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1029,7 +1040,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1134,7 +1145,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1197,7 +1208,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1329,7 +1340,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1392,7 +1403,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1497,7 +1508,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1560,7 +1571,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1677,7 +1688,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1740,7 +1751,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1851,7 +1862,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1914,7 +1925,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2185,7 +2196,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2374,6 +2385,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -2592,7 +2614,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2655,7 +2677,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2765,7 +2787,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2828,7 +2850,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2951,7 +2973,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3014,7 +3036,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3143,7 +3165,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3206,7 +3228,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3311,7 +3333,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3374,7 +3396,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3506,7 +3528,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3569,7 +3591,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3674,7 +3696,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3737,7 +3759,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3854,7 +3876,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3917,7 +3939,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4028,7 +4050,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4091,7 +4113,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4362,7 +4384,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4510,6 +4532,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -4660,7 +4693,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4723,7 +4756,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4828,7 +4861,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4891,7 +4924,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5023,7 +5056,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5086,7 +5119,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5191,7 +5224,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5254,7 +5287,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5371,7 +5404,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5434,7 +5467,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5545,7 +5578,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5608,7 +5641,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5791,6 +5824,17 @@

Method Details

"conditionBoostSpecs": [ # Optional. 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, # Optional. 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. + "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. # Optional. Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # 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", # Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # Optional. 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", # Optional. The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # Optional. The interpolation type to be applied to connect the control points listed below. + }, "condition": "A String", # Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) }, ], @@ -5994,7 +6038,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6057,7 +6101,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6167,7 +6211,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6230,7 +6274,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6353,7 +6397,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6416,7 +6460,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6545,7 +6589,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6608,7 +6652,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6713,7 +6757,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6776,7 +6820,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6908,7 +6952,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6971,7 +7015,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7076,7 +7120,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7139,7 +7183,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7256,7 +7300,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7319,7 +7363,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7430,7 +7474,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7493,7 +7537,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7764,7 +7808,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index b1071f9aa9b..6689ab8de38 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -310,7 +310,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -373,7 +373,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -484,7 +484,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -547,7 +547,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -662,7 +662,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -725,7 +725,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -861,7 +861,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -924,7 +924,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1034,7 +1034,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1097,7 +1097,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1220,7 +1220,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1283,7 +1283,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1412,7 +1412,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1475,7 +1475,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1580,7 +1580,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1643,7 +1643,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1775,7 +1775,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1838,7 +1838,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1943,7 +1943,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2006,7 +2006,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2123,7 +2123,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2186,7 +2186,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2297,7 +2297,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2360,7 +2360,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2498,7 +2498,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2561,7 +2561,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2671,7 +2671,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2734,7 +2734,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2857,7 +2857,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2920,7 +2920,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3049,7 +3049,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3112,7 +3112,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3217,7 +3217,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3280,7 +3280,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3412,7 +3412,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3475,7 +3475,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3580,7 +3580,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3643,7 +3643,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3760,7 +3760,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3823,7 +3823,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3934,7 +3934,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -3997,7 +3997,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4106,7 +4106,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4169,7 +4169,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4375,7 +4375,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4438,7 +4438,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4543,7 +4543,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4606,7 +4606,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4738,7 +4738,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4801,7 +4801,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4906,7 +4906,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -4969,7 +4969,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5086,7 +5086,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5149,7 +5149,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5260,7 +5260,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5323,7 +5323,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5373,7 +5373,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5579,7 +5579,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5642,7 +5642,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5747,7 +5747,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5810,7 +5810,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -5942,7 +5942,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6005,7 +6005,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6110,7 +6110,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6173,7 +6173,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6290,7 +6290,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6353,7 +6353,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6464,7 +6464,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6527,7 +6527,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6577,7 +6577,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6794,7 +6794,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6857,7 +6857,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -6962,7 +6962,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7025,7 +7025,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7157,7 +7157,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7220,7 +7220,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7325,7 +7325,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7388,7 +7388,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7505,7 +7505,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7568,7 +7568,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7679,7 +7679,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7742,7 +7742,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7792,7 +7792,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -7998,7 +7998,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8061,7 +8061,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8166,7 +8166,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8229,7 +8229,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8361,7 +8361,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8424,7 +8424,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8529,7 +8529,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8592,7 +8592,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8709,7 +8709,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8772,7 +8772,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8883,7 +8883,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8946,7 +8946,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -8996,7 +8996,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9264,7 +9264,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9327,7 +9327,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9432,7 +9432,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9495,7 +9495,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9627,7 +9627,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9690,7 +9690,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9795,7 +9795,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9858,7 +9858,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -9975,7 +9975,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10038,7 +10038,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10149,7 +10149,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10212,7 +10212,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10262,7 +10262,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10468,7 +10468,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10531,7 +10531,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10636,7 +10636,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10699,7 +10699,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10831,7 +10831,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10894,7 +10894,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -10999,7 +10999,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11062,7 +11062,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11179,7 +11179,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11242,7 +11242,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11353,7 +11353,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11416,7 +11416,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11466,7 +11466,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11743,7 +11743,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11806,7 +11806,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11911,7 +11911,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -11974,7 +11974,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12106,7 +12106,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12169,7 +12169,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12274,7 +12274,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12337,7 +12337,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12454,7 +12454,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12517,7 +12517,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12628,7 +12628,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12691,7 +12691,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12741,7 +12741,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -12947,7 +12947,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13010,7 +13010,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13115,7 +13115,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13178,7 +13178,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13310,7 +13310,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13373,7 +13373,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13478,7 +13478,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13541,7 +13541,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13658,7 +13658,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13721,7 +13721,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13832,7 +13832,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13895,7 +13895,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -13945,7 +13945,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14180,7 +14180,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14243,7 +14243,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14348,7 +14348,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14411,7 +14411,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14543,7 +14543,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14606,7 +14606,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14711,7 +14711,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14774,7 +14774,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14891,7 +14891,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -14954,7 +14954,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15065,7 +15065,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15128,7 +15128,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15178,7 +15178,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15384,7 +15384,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15447,7 +15447,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15552,7 +15552,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15615,7 +15615,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15747,7 +15747,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15810,7 +15810,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15915,7 +15915,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -15978,7 +15978,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16095,7 +16095,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16158,7 +16158,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16269,7 +16269,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16332,7 +16332,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16382,7 +16382,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16600,7 +16600,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16663,7 +16663,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16768,7 +16768,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16831,7 +16831,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -16963,7 +16963,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17026,7 +17026,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17131,7 +17131,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17194,7 +17194,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17311,7 +17311,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17374,7 +17374,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17485,7 +17485,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17548,7 +17548,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17598,7 +17598,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17804,7 +17804,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17867,7 +17867,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -17972,7 +17972,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18035,7 +18035,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18167,7 +18167,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18230,7 +18230,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18335,7 +18335,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18398,7 +18398,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18515,7 +18515,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18578,7 +18578,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18689,7 +18689,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18752,7 +18752,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -18802,7 +18802,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html index 2dd36b48ddb..ae353502e81 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html @@ -265,7 +265,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -328,7 +328,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -433,7 +433,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -496,7 +496,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -628,7 +628,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -691,7 +691,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -796,7 +796,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -859,7 +859,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -976,7 +976,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1039,7 +1039,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1150,7 +1150,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1213,7 +1213,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1263,7 +1263,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1487,7 +1487,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1550,7 +1550,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1655,7 +1655,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1718,7 +1718,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1850,7 +1850,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1913,7 +1913,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2018,7 +2018,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2081,7 +2081,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2198,7 +2198,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2261,7 +2261,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2372,7 +2372,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2435,7 +2435,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -2485,7 +2485,7 @@

Method Details

"textResponses": [ # The text responses from the agent for the turn. { # The text response message. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html index 78b4226a0c2..7e33abe0d3a 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html @@ -145,6 +145,9 @@

Method Details

"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. "requestLocation": "A String", # Required. Key location in the request. }, + "bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth. + "token": "A String", # Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + }, "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth. "clientId": "A String", # Required. The client ID from the OAuth provider. "clientSecret": "A String", # Required. The client secret from the OAuth provider. @@ -152,6 +155,7 @@

Method Details

"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. }, "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. }, }, "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. @@ -210,6 +214,9 @@

Method Details

"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. "requestLocation": "A String", # Required. Key location in the request. }, + "bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth. + "token": "A String", # Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + }, "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth. "clientId": "A String", # Required. The client ID from the OAuth provider. "clientSecret": "A String", # Required. The client secret from the OAuth provider. @@ -217,6 +224,7 @@

Method Details

"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. }, "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. }, }, "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. @@ -348,6 +356,9 @@

Method Details

"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. "requestLocation": "A String", # Required. Key location in the request. }, + "bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth. + "token": "A String", # Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + }, "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth. "clientId": "A String", # Required. The client ID from the OAuth provider. "clientSecret": "A String", # Required. The client secret from the OAuth provider. @@ -355,6 +366,7 @@

Method Details

"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. }, "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. }, }, "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. @@ -425,6 +437,9 @@

Method Details

"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. "requestLocation": "A String", # Required. Key location in the request. }, + "bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth. + "token": "A String", # Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + }, "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth. "clientId": "A String", # Required. The client ID from the OAuth provider. "clientSecret": "A String", # Required. The client secret from the OAuth provider. @@ -432,6 +447,7 @@

Method Details

"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. }, "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. }, }, "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. @@ -508,6 +524,9 @@

Method Details

"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. "requestLocation": "A String", # Required. Key location in the request. }, + "bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth. + "token": "A String", # Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + }, "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth. "clientId": "A String", # Required. The client ID from the OAuth provider. "clientSecret": "A String", # Required. The client secret from the OAuth provider. @@ -515,6 +534,7 @@

Method Details

"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. }, "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. }, }, "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. @@ -574,6 +594,9 @@

Method Details

"keyName": "A String", # Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. "requestLocation": "A String", # Required. Key location in the request. }, + "bearerTokenConfig": { # Config for authentication using bearer token. # Config for bearer token auth. + "token": "A String", # Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`. + }, "oauthConfig": { # Config for authentication with OAuth. # Config for OAuth. "clientId": "A String", # Required. The client ID from the OAuth provider. "clientSecret": "A String", # Required. The client secret from the OAuth provider. @@ -581,6 +604,7 @@

Method Details

"tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token. }, "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth. + "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header. }, }, "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html index 621b3719dbc..9b37ece22ed 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html @@ -196,7 +196,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -259,7 +259,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -381,7 +381,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -444,7 +444,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -592,7 +592,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -655,7 +655,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -789,7 +789,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -852,7 +852,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -991,7 +991,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1054,7 +1054,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1177,7 +1177,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, @@ -1240,7 +1240,7 @@

Method Details

}, "text": { # The text response message. # Returns a text response. "allowPlaybackInterruption": True or False, # Output only. Whether the playback of this message can be interrupted by the end user's speech and the client can then starts the next Dialogflow request. - "text": [ # Required. A collection of text responses. + "text": [ # Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime. "A String", ], }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html index 14998491459..86c151c4d08 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html @@ -234,7 +234,7 @@

Method Details

"databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. - "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "projectId": "A String", # The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. }, "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. @@ -247,7 +247,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -270,7 +270,7 @@

Method Details

"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 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. + "projectId": "A String", # The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -278,7 +278,7 @@

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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. "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. + "projectId": "A String", # The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -332,7 +332,7 @@

Method Details

"databaseId": "A String", # Required. The database ID of the source Spanner table. "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. + "projectId": "A String", # The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html index ad0ebd6e4cd..3a9587973f0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.html @@ -84,10 +84,41 @@

Instance Methods

Returns the operations Resource.

+

+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

+
+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Gets index freshness metadata for Documents. Supported for website search only.
+
+Args:
+  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
+  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 DocumentService.BatchGetDocumentsMetadata method.
+  "documentsMetadata": [ # The metadata of the Documents.
+    { # The metadata of a Document.
+      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
+      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
+        "uri": "A String", # If match by URI, the URI of the Document.
+      },
+      "status": "A String", # The status of the document.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionSuggestions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionSuggestions.html index 7d121392cae..c1811c7f075 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionSuggestions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionSuggestions.html @@ -108,7 +108,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html index 068d81d115f..574ee9cf4b7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html new file mode 100644 index 00000000000..83d55b459f5 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.customModels.html @@ -0,0 +1,120 @@ + + + +

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

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(dataStore, x__xgafv=None)

+

Gets a list of all the custom models.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(dataStore, x__xgafv=None) +
Gets a list of all the custom models.
+
+Args:
+  dataStore: string, Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. (required)
+  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 SearchTuningService.ListCustomModels method.
+  "models": [ # List of custom tuning models.
+    { # Metadata that describes a custom tuned model.
+      "createTime": "A String", # Timestamp the Model was created at.
+      "displayName": "A String", # The display name of the model.
+      "metrics": { # The metrics of the trained model.
+        "a_key": 3.14,
+      },
+      "modelState": "A String", # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
+      "modelVersion": "A String", # The version of the model.
+      "name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.
+      "trainingStartTime": "A String", # Timestamp the model training was initiated.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 57dc1374ce8..f6a02354045 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -94,6 +94,11 @@

Instance Methods

Returns the conversations Resource.

+

+ customModels() +

+

Returns the customModels Resource.

+

models()

@@ -161,6 +166,9 @@

Instance Methods

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

Updates a DataStore

+

+ trainCustomModel(dataStore, body=None, x__xgafv=None)

+

Trains a custom model.

Method Details

close() @@ -259,6 +267,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -394,6 +406,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
@@ -487,6 +503,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -568,6 +588,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -631,6 +655,62 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, +}
+
+ +
+ trainCustomModel(dataStore, body=None, x__xgafv=None) +
Trains a custom model.
+
+Args:
+  dataStore: string, Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SearchTuningService.TrainCustomModel method.
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the data ingestion and training.
+    "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.
+  },
+  "gcsTrainingInput": { # Cloud Storage training data input. # Cloud Storage training input.
+    "corpusDataPath": "A String", # The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
+    "queryDataPath": "A String", # The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"}
+    "testDataPath": "A String", # Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.
+    "trainDataPath": "A String", # Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1`
+  },
+  "modelId": "A String", # If not provided, a UUID will be generated.
+  "modelType": "A String", # Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.
+}
+
+  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.
+  },
 }
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html index 041c60bc744..40bf7b11a9c 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.userEvents.html @@ -142,7 +142,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. Cannot be set for inline user event imports. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html index 780468424dd..4c897c26ac7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html index 59d562fcc20..5c907a467b0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html @@ -234,7 +234,7 @@

Method Details

"databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. - "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "projectId": "A String", # The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. }, "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. @@ -247,7 +247,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -270,7 +270,7 @@

Method Details

"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 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. + "projectId": "A String", # The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -278,7 +278,7 @@

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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. "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. + "projectId": "A String", # The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -332,7 +332,7 @@

Method Details

"databaseId": "A String", # Required. The database ID of the source Spanner table. "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. + "projectId": "A String", # The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html index 4da95357b46..02b2c6adce8 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.html @@ -84,10 +84,41 @@

Instance Methods

Returns the operations Resource.

+

+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

+
+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Gets index freshness metadata for Documents. Supported for website search only.
+
+Args:
+  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
+  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 DocumentService.BatchGetDocumentsMetadata method.
+  "documentsMetadata": [ # The metadata of the Documents.
+    { # The metadata of a Document.
+      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
+      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
+        "uri": "A String", # If match by URI, the URI of the Document.
+      },
+      "status": "A String", # The status of the document.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionSuggestions.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionSuggestions.html index 5c4dcd7cc5f..fc3ca61cb97 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionSuggestions.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionSuggestions.html @@ -108,7 +108,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html index 21c632ef75f..1b1801f1c71 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index 7145c19ac3c..db5521e4dd5 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -259,6 +259,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -394,6 +398,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
@@ -487,6 +495,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -568,6 +580,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -631,6 +647,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html index 478b728f208..28c3bd4dcbf 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.userEvents.html @@ -142,7 +142,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. Cannot be set for inline user event imports. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html index b2d21a8426f..59962003856 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.groundingConfigs.html @@ -135,6 +135,7 @@

Method Details

"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. "groundingCheckRequired": True or False, # Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. + "score": 3.14, # Confidence score for the claim in the answer candidate, in the range of [0, 1]. "startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes. }, ], 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 04bf2b6045b..429786ba56d 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 @@ -311,7 +311,7 @@

Method Details

"databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. - "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "projectId": "A String", # The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. }, "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. @@ -324,7 +324,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -347,7 +347,7 @@

Method Details

"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 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. + "projectId": "A String", # The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -355,7 +355,7 @@

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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. "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. + "projectId": "A String", # The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -422,7 +422,7 @@

Method Details

"databaseId": "A String", # Required. The database ID of the source Spanner table. "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. + "projectId": "A String", # The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html index 943fd66b68f..6fa20df4abb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.html @@ -84,10 +84,41 @@

Instance Methods

Returns the operations Resource.

+

+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

+
+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Gets index freshness metadata for Documents. Supported for website search only.
+
+Args:
+  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
+  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 DocumentService.BatchGetDocumentsMetadata method.
+  "documentsMetadata": [ # The metadata of the Documents.
+    { # The metadata of a Document.
+      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
+      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
+        "uri": "A String", # If match by URI, the URI of the Document.
+      },
+      "status": "A String", # The status of the document.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionSuggestions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionSuggestions.html index d3d0dbe07a4..f48c7213e27 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionSuggestions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionSuggestions.html @@ -108,7 +108,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html index 3f7d396dcc8..bc0be4976bd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 61be9086324..55ae09957fe 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -305,6 +305,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -472,6 +476,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
@@ -648,6 +656,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -761,6 +773,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -856,6 +872,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
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 f35c711a7c1..aac1610fb9f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1183,6 +1183,7 @@

Method Details

}, "stringConstraint": { # Constraint expression of a string field. # String constraint expression. "fieldName": "A String", # Name of the string field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "values": [ # Values of the string field. The record will only be returned if the field value matches one of the values specified here. "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 2c120cf13da..6f0fca63a88 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.userEvents.html @@ -142,7 +142,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. Cannot be set for inline user event imports. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html index be2f33aaaff..f15c2084294 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control 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 563bc3ec0c0..f16b40a938f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1183,6 +1183,7 @@

Method Details

}, "stringConstraint": { # Constraint expression of a string field. # String constraint expression. "fieldName": "A String", # Name of the string field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "values": [ # Values of the string field. The record will only be returned if the field value matches one of the values specified here. "A String", ], 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 87a6249a2d0..ac637335625 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -311,7 +311,7 @@

Method Details

"databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. - "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "projectId": "A String", # The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. }, "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. @@ -324,7 +324,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -347,7 +347,7 @@

Method Details

"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 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. + "projectId": "A String", # The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -355,7 +355,7 @@

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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. "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. + "projectId": "A String", # The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -422,7 +422,7 @@

Method Details

"databaseId": "A String", # Required. The database ID of the source Spanner table. "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. + "projectId": "A String", # The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html index 98665f93781..ac371f62254 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.html @@ -84,10 +84,41 @@

Instance Methods

Returns the operations Resource.

+

+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

+
+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Gets index freshness metadata for Documents. Supported for website search only.
+
+Args:
+  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
+  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 DocumentService.BatchGetDocumentsMetadata method.
+  "documentsMetadata": [ # The metadata of the Documents.
+    { # The metadata of a Document.
+      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
+      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
+        "uri": "A String", # If match by URI, the URI of the Document.
+      },
+      "status": "A String", # The status of the document.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionSuggestions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionSuggestions.html index d279a3fab3c..e32778547d4 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionSuggestions.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionSuggestions.html @@ -108,7 +108,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html index 9869f6245e4..bceedd99fc8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 49cb9daf72e..a89d5bb5200 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -297,6 +297,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -464,6 +468,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
@@ -640,6 +648,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -753,6 +765,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -848,6 +864,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index f77feb6aabf..765210a61ce 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1183,6 +1183,7 @@

Method Details

}, "stringConstraint": { # Constraint expression of a string field. # String constraint expression. "fieldName": "A String", # Name of the string field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "values": [ # Values of the string field. The record will only be returned if the field value matches one of the values specified here. "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 bdaee7cc987..33f036e732f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.userEvents.html @@ -142,7 +142,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. Cannot be set for inline user event imports. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html index c900e5e3af1..caa609c0808 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.groundingConfigs.html @@ -135,6 +135,7 @@

Method Details

"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. "groundingCheckRequired": True or False, # Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. + "score": 3.14, # Confidence score for the claim in the answer candidate, in the range of [0, 1]. "startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes. }, ], diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index c07864082b1..43ac142966e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -124,6 +124,11 @@

Instance Methods

Returns the userEvents Resource.

+

+ userStores() +

+

Returns the userStores Resource.

+

close()

Close httplib2 connections.

@@ -135,7 +140,7 @@

Instance Methods

Gets the AclConfig.

updateAclConfig(name, body=None, x__xgafv=None)

-

Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

+

Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Method Details

close() @@ -162,7 +167,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -239,7 +244,7 @@

Method Details

updateAclConfig(name, body=None, x__xgafv=None) -
Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
+  
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
 
 Args:
   name: string, Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html
index 241beacd394..eb4f61c2604 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html
@@ -226,7 +226,7 @@ 

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html new file mode 100644 index 00000000000..c7d9ed1d706 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . userStores

+

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.userStores.operations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.operations.html new file mode 100644 index 00000000000..a902cbe89ef --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.operations.html @@ -0,0 +1,187 @@ + + + +

Discovery Engine API . projects . locations . userStores . 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.

+

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

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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_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/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index c83e856c978..fb57272adb1 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 @@ -234,7 +234,7 @@

Method Details

"databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. - "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "projectId": "A String", # The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. }, "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. @@ -247,7 +247,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -270,7 +270,7 @@

Method Details

"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 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. + "projectId": "A String", # The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -278,7 +278,7 @@

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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. "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. + "projectId": "A String", # The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -332,7 +332,7 @@

Method Details

"databaseId": "A String", # Required. The database ID of the source Spanner table. "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. + "projectId": "A String", # The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html index f0b3c9b9d3f..411b26f5dbe 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.html @@ -84,10 +84,41 @@

Instance Methods

Returns the operations Resource.

+

+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

+
+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Gets index freshness metadata for Documents. Supported for website search only.
+
+Args:
+  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
+  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 DocumentService.BatchGetDocumentsMetadata method.
+  "documentsMetadata": [ # The metadata of the Documents.
+    { # The metadata of a Document.
+      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
+      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
+        "uri": "A String", # If match by URI, the URI of the Document.
+      },
+      "status": "A String", # The status of the document.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionSuggestions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionSuggestions.html index 77e64bc63c1..1e6a55d9ea2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionSuggestions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionSuggestions.html @@ -108,7 +108,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html index a5b6008bf54..0a4e8c7d88e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 83fd962f5e4..745a3f27da5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -273,6 +273,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -414,6 +418,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
@@ -513,6 +521,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -600,6 +612,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -669,6 +685,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
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 ed353dd268c..ecd2da96bad 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1030,6 +1030,7 @@

Method Details

}, "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. @@ -1131,6 +1132,7 @@

Method Details

}, "stringConstraint": { # Constraint expression of a string field. # String constraint expression. "fieldName": "A String", # Name of the string field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "values": [ # Values of the string field. The record will only be returned if the field value matches one of the values specified here. "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 0fc40824428..fd768429f1e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.userEvents.html @@ -142,7 +142,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. Cannot be set for inline user event imports. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html index 8fc0064d00c..06cc50dc1d9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control 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 edaa8f2052f..e509d9cc627 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1030,6 +1030,7 @@

Method Details

}, "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. @@ -1131,6 +1132,7 @@

Method Details

}, "stringConstraint": { # Constraint expression of a string field. # String constraint expression. "fieldName": "A String", # Name of the string field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "values": [ # Values of the string field. The record will only be returned if the field value matches one of the values specified here. "A String", ], 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 6c94b292281..21abd556da5 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -234,7 +234,7 @@

Method Details

"databaseId": "A String", # Required. The AlloyDB database to copy the data from with a length limit of 256 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 AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "locationId": "A String", # Required. The AlloyDB location to copy the data from with a length limit of 256 characters. - "projectId": "A String", # The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + "projectId": "A String", # The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The AlloyDB table to copy the data from with a length limit of 256 characters. }, "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. @@ -247,7 +247,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -270,7 +270,7 @@

Method Details

"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 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. + "projectId": "A String", # The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -278,7 +278,7 @@

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 Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. "instanceId": "A String", # Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. "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. + "projectId": "A String", # The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. @@ -332,7 +332,7 @@

Method Details

"databaseId": "A String", # Required. The database ID of the source Spanner table. "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. + "projectId": "A String", # The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "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. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html index 7ef50b8cd80..18f192f047a 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.html @@ -84,10 +84,41 @@

Instance Methods

Returns the operations Resource.

+

+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None)

+

Gets index freshness metadata for Documents. Supported for website search only.

close()

Close httplib2 connections.

Method Details

+
+ batchGetDocumentsMetadata(parent, matcher_urisMatcher_uris=None, x__xgafv=None) +
Gets index freshness metadata for Documents. Supported for website search only.
+
+Args:
+  parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. (required)
+  matcher_urisMatcher_uris: string, The exact URIs to match by. (repeated)
+  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 DocumentService.BatchGetDocumentsMetadata method.
+  "documentsMetadata": [ # The metadata of the Documents.
+    { # The metadata of a Document.
+      "lastRefreshedTime": "A String", # The timestamp of the last time the Document was last indexed.
+      "matcherValue": { # The value of the matcher that was used to match the Document. # The value of the matcher that was used to match the Document.
+        "uri": "A String", # If match by URI, the URI of the Document.
+      },
+      "status": "A String", # The status of the document.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionSuggestions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionSuggestions.html index 8a0fd6b14fa..75577a02791 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionSuggestions.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionSuggestions.html @@ -108,7 +108,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html index 370c8a9c8af..71ed29e99f0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.controls.html @@ -111,7 +111,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -165,7 +165,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -243,7 +243,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -308,7 +308,7 @@

Method Details

{ # Response for ListControls method. "controls": [ # All the Controls for a given data store. { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -380,7 +380,7 @@

Method Details

The object takes the form of: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control @@ -434,7 +434,7 @@

Method Details

An object of the form: { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - "associatedServingConfigIds": [ # Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. "A String", ], "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 5006f7a4520..2e4435a2ac6 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -265,6 +265,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } createAdvancedSiteSearch: boolean, A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. @@ -406,6 +410,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }
@@ -505,6 +513,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, }, ], "nextPageToken": "A String", # A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -592,6 +604,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } updateMask: string, Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. @@ -661,6 +677,10 @@

Method Details

"a_key": "", # Properties of the object. }, }, + "workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + "dasherCustomerId": "A String", # Obfuscated Dasher customer ID. + "type": "A String", # The Google Workspace data source. + }, } diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 9ce09f99f04..c195c085adc 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1030,6 +1030,7 @@

Method Details

}, "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. @@ -1131,6 +1132,7 @@

Method Details

}, "stringConstraint": { # Constraint expression of a string field. # String constraint expression. "fieldName": "A String", # Name of the string field as defined in the schema. + "querySegment": "A String", # Identifies the keywords within the search query that match a filter. "values": [ # Values of the string field. The record will only be returned if the field value matches one of the values specified here. "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 50e7829bd27..2072aa6f462 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.userEvents.html @@ -142,7 +142,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. Cannot be set for inline user event imports. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index ccb946f044f..deeedcac997 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -269,6 +269,7 @@

Method Details

}, "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. @@ -525,6 +526,7 @@

Method Details

}, "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. @@ -757,6 +759,7 @@

Method Details

}, "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. "regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search. "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html index 644310dc38d..8aa1ebd5712 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.groundingConfigs.html @@ -135,6 +135,7 @@

Method Details

"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. "groundingCheckRequired": True or False, # Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. + "score": 3.14, # Confidence score for the claim in the answer candidate, in the range of [0, 1]. "startPos": 42, # Position indicating the start of the claim in the answer candidate, measured in bytes. }, ], diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html index a2fed7b07bf..a80c2af1056 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html @@ -226,7 +226,7 @@

Method Details

"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. }, - "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. + "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. }, "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import. diff --git a/docs/dyn/displayvideo_v2.advertisers.creatives.html b/docs/dyn/displayvideo_v2.advertisers.creatives.html index 3ecf31487b2..df79ae18ffb 100644 --- a/docs/dyn/displayvideo_v2.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v2.advertisers.creatives.html @@ -209,7 +209,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -369,7 +369,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -556,7 +556,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -729,7 +729,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -909,7 +909,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. @@ -1070,7 +1070,7 @@

Method Details

"status": "A String", # Status of the exchange review. }, ], - "publisherReviewStatuses": [ # Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + "publisherReviewStatuses": [ # Publisher review statuses for the creative. { # Publisher review status for the creative. "publisherName": "A String", # The publisher reviewing the creative. "status": "A String", # Status of the publisher review. diff --git a/docs/dyn/dlp_v2.infoTypes.html b/docs/dyn/dlp_v2.infoTypes.html index a8d6590a00c..20eba9c0b4a 100644 --- a/docs/dyn/dlp_v2.infoTypes.html +++ b/docs/dyn/dlp_v2.infoTypes.html @@ -94,7 +94,7 @@

Method Details

filter: string, filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT. languageCode: string, BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned. locationId: string, Deprecated. This field has no effect. - parent: string, The parent resource name. The format of this value is as follows: locations/ LOCATION_ID + parent: string, The parent resource name. The format of this value is as follows: `locations/{location_id}` x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/dlp_v2.locations.infoTypes.html b/docs/dyn/dlp_v2.locations.infoTypes.html index 9af670a9fba..898e9adf173 100644 --- a/docs/dyn/dlp_v2.locations.infoTypes.html +++ b/docs/dyn/dlp_v2.locations.infoTypes.html @@ -91,7 +91,7 @@

Method Details

Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.
 
 Args:
-  parent: string, The parent resource name. The format of this value is as follows: locations/ LOCATION_ID (required)
+  parent: string, The parent resource name. The format of this value is as follows: `locations/{location_id}` (required)
   filter: string, filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
   languageCode: string, BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
   locationId: string, Deprecated. This field has no effect.
diff --git a/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html b/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html
index d1a5c3e146a..243c281642f 100644
--- a/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html
+++ b/docs/dyn/dlp_v2.organizations.deidentifyTemplates.html
@@ -106,7 +106,7 @@ 

Method Details

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -282,7 +282,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -575,7 +575,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -814,7 +814,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1156,7 +1156,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1449,7 +1449,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1688,7 +1688,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2052,7 +2052,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2345,7 +2345,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2584,7 +2584,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2750,7 +2750,7 @@

Method Details

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2936,7 +2936,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3229,7 +3229,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3468,7 +3468,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3827,7 +3827,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4120,7 +4120,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4359,7 +4359,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4700,7 +4700,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4993,7 +4993,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5232,7 +5232,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html index d67adcf363b..184edb6d354 100644 --- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html @@ -106,7 +106,7 @@

Method Details

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -719,7 +719,7 @@ 

Method Details

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.organizations.locations.connections.html b/docs/dyn/dlp_v2.organizations.locations.connections.html
index 9ce7ffa12e7..d280ed2c0e4 100644
--- a/docs/dyn/dlp_v2.organizations.locations.connections.html
+++ b/docs/dyn/dlp_v2.organizations.locations.connections.html
@@ -112,7 +112,7 @@ 

Method Details

Create a Connection to an external data source.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html b/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html
index 0bd7450fa77..38a594af0dd 100644
--- a/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html
+++ b/docs/dyn/dlp_v2.organizations.locations.deidentifyTemplates.html
@@ -106,7 +106,7 @@ 

Method Details

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -282,7 +282,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -575,7 +575,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -814,7 +814,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1156,7 +1156,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1449,7 +1449,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1688,7 +1688,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2052,7 +2052,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2345,7 +2345,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2584,7 +2584,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2750,7 +2750,7 @@

Method Details

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2936,7 +2936,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3229,7 +3229,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3468,7 +3468,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3827,7 +3827,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4120,7 +4120,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4359,7 +4359,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4700,7 +4700,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4993,7 +4993,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5232,7 +5232,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index cd115487780..790cb4182ac 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -106,7 +106,7 @@

Method Details

Creates a config for discovery to scan and profile storage.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -138,6 +138,22 @@ 

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -262,6 +278,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -355,6 +374,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -479,6 +514,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -596,6 +634,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -720,6 +774,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -784,7 +841,7 @@

Method Details

Lists discovery configurations.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   orderBy: string, Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.
   pageSize: integer, Size of the page. This value can be limited by a server.
   pageToken: string, Page token to continue retrieval. Comes from the previous call to ListDiscoveryConfigs. `order_by` field must not change for subsequent calls.
@@ -824,6 +881,22 @@ 

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -948,6 +1021,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -1060,6 +1136,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -1184,6 +1276,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -1278,6 +1373,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -1402,6 +1513,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index 3531d912129..e5900221742 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -94,7 +94,7 @@

Method Details

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`
@@ -296,7 +296,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -589,7 +589,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -828,7 +828,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1158,7 +1158,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1451,7 +1451,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1690,7 +1690,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2020,7 +2020,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2313,7 +2313,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2552,7 +2552,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3035,7 +3035,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 6ed4b124f3e..99a1244c303 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -155,6 +155,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -192,6 +208,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -316,6 +348,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -589,12 +624,12 @@

Method Details

"fileClusterType": { # Message used to identify file cluster type being profiled. # The file cluster type. "cluster": "A String", # Cluster type. }, - "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. + "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, ], - "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. + "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, @@ -729,6 +764,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -766,6 +817,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -890,6 +957,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -1163,12 +1233,12 @@

Method Details

"fileClusterType": { # Message used to identify file cluster type being profiled. # The file cluster type. "cluster": "A String", # Cluster type. }, - "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. + "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, ], - "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. + "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html index c9e19457c59..187a287ff13 100644 --- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html +++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html @@ -106,7 +106,7 @@

Method Details

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -719,7 +719,7 @@ 

Method Details

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
index 1fee6ff59f8..1d2a8e9e983 100644
--- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
@@ -106,7 +106,7 @@ 

Method Details

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -431,7 +431,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -783,7 +783,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -1157,7 +1157,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -1184,7 +1184,7 @@

Method Details

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
@@ -1525,7 +1525,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -1894,7 +1894,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -2245,7 +2245,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, diff --git a/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html b/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html index d2cd652d510..5757c45a002 100644 --- a/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.organizations.locations.storedInfoTypes.html @@ -106,7 +106,7 @@

Method Details

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -468,7 +468,7 @@ 

Method Details

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
index 9e17c08a420..8995e97a856 100644
--- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
+++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
@@ -155,6 +155,22 @@ 

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -192,6 +208,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -316,6 +348,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -673,6 +708,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -710,6 +761,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -834,6 +901,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. diff --git a/docs/dyn/dlp_v2.organizations.storedInfoTypes.html b/docs/dyn/dlp_v2.organizations.storedInfoTypes.html index b3e720495c2..dbd477b65ea 100644 --- a/docs/dyn/dlp_v2.organizations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.organizations.storedInfoTypes.html @@ -106,7 +106,7 @@

Method Details

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -468,7 +468,7 @@ 

Method Details

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html
index 8581a850ae0..a8f6fa484b3 100644
--- a/docs/dyn/dlp_v2.projects.content.html
+++ b/docs/dyn/dlp_v2.projects.content.html
@@ -97,7 +97,7 @@ 

Method Details

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -271,7 +271,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -564,7 +564,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -803,7 +803,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1416,7 +1416,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1655,7 +1655,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1943,7 +1943,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2062,7 +2062,7 @@

Method Details

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2431,7 +2431,7 @@ 

Method Details

Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2824,7 +2824,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3117,7 +3117,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3356,7 +3356,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3750,7 +3750,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3989,7 +3989,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4277,7 +4277,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. diff --git a/docs/dyn/dlp_v2.projects.deidentifyTemplates.html b/docs/dyn/dlp_v2.projects.deidentifyTemplates.html index f5552271f87..4c69429d900 100644 --- a/docs/dyn/dlp_v2.projects.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.projects.deidentifyTemplates.html @@ -106,7 +106,7 @@

Method Details

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -282,7 +282,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -575,7 +575,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -814,7 +814,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1156,7 +1156,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1449,7 +1449,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1688,7 +1688,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2052,7 +2052,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2345,7 +2345,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2584,7 +2584,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2750,7 +2750,7 @@

Method Details

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2936,7 +2936,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3229,7 +3229,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3468,7 +3468,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3827,7 +3827,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4120,7 +4120,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4359,7 +4359,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4700,7 +4700,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4993,7 +4993,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5232,7 +5232,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 697861bf616..3707b8bf714 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -130,7 +130,7 @@

Method Details

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -434,7 +434,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -797,7 +797,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1090,7 +1090,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1329,7 +1329,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1659,7 +1659,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1952,7 +1952,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2191,7 +2191,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2521,7 +2521,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2814,7 +2814,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3053,7 +3053,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3536,7 +3536,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4524,7 +4524,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4817,7 +4817,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5056,7 +5056,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5386,7 +5386,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5679,7 +5679,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5918,7 +5918,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -6248,7 +6248,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -6541,7 +6541,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -6780,7 +6780,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -7263,7 +7263,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -8043,7 +8043,7 @@

Method Details

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`
@@ -8245,7 +8245,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -8538,7 +8538,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -8777,7 +8777,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9107,7 +9107,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9400,7 +9400,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9639,7 +9639,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9969,7 +9969,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -10262,7 +10262,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -10501,7 +10501,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -10984,7 +10984,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html index 93babe01a8e..3c51b1e8c75 100644 --- a/docs/dyn/dlp_v2.projects.image.html +++ b/docs/dyn/dlp_v2.projects.image.html @@ -91,7 +91,7 @@

Method Details

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/dlp_v2.projects.inspectTemplates.html b/docs/dyn/dlp_v2.projects.inspectTemplates.html
index ade2c86820f..a5b84d209ba 100644
--- a/docs/dyn/dlp_v2.projects.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html
@@ -106,7 +106,7 @@ 

Method Details

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -719,7 +719,7 @@ 

Method Details

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html
index 41de898349f..561b82a37e5 100644
--- a/docs/dyn/dlp_v2.projects.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.jobTriggers.html
@@ -300,7 +300,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -593,7 +593,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -832,7 +832,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1162,7 +1162,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1455,7 +1455,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1694,7 +1694,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2024,7 +2024,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2317,7 +2317,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2556,7 +2556,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3039,7 +3039,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -3824,7 +3824,7 @@

Method Details

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -4149,7 +4149,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4501,7 +4501,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4875,7 +4875,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4902,7 +4902,7 @@

Method Details

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
@@ -5243,7 +5243,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -5612,7 +5612,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -5963,7 +5963,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.connections.html b/docs/dyn/dlp_v2.projects.locations.connections.html index 73b6eb40546..bf6d35457d8 100644 --- a/docs/dyn/dlp_v2.projects.locations.connections.html +++ b/docs/dyn/dlp_v2.projects.locations.connections.html @@ -112,7 +112,7 @@

Method Details

Create a Connection to an external data source.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html
index b2d8529ba88..6723dd1cb6d 100644
--- a/docs/dyn/dlp_v2.projects.locations.content.html
+++ b/docs/dyn/dlp_v2.projects.locations.content.html
@@ -97,7 +97,7 @@ 

Method Details

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -271,7 +271,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -564,7 +564,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -803,7 +803,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1416,7 +1416,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1655,7 +1655,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1943,7 +1943,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2062,7 +2062,7 @@

Method Details

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2431,7 +2431,7 @@ 

Method Details

Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -2824,7 +2824,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3117,7 +3117,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3356,7 +3356,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3750,7 +3750,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3989,7 +3989,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4277,7 +4277,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. diff --git a/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html b/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html index d60aacfd73b..b18c3ed831c 100644 --- a/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html +++ b/docs/dyn/dlp_v2.projects.locations.deidentifyTemplates.html @@ -106,7 +106,7 @@

Method Details

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -282,7 +282,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -575,7 +575,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -814,7 +814,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1156,7 +1156,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1449,7 +1449,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1688,7 +1688,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2052,7 +2052,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2345,7 +2345,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2584,7 +2584,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2750,7 +2750,7 @@

Method Details

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
@@ -2936,7 +2936,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3229,7 +3229,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3468,7 +3468,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3827,7 +3827,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4120,7 +4120,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4359,7 +4359,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4700,7 +4700,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4993,7 +4993,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5232,7 +5232,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 32bd1240c8c..d109c64d1b0 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -106,7 +106,7 @@

Method Details

Creates a config for discovery to scan and profile storage.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -138,6 +138,22 @@ 

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -262,6 +278,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -355,6 +374,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -479,6 +514,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -596,6 +634,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -720,6 +774,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -784,7 +841,7 @@

Method Details

Lists discovery configurations.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   orderBy: string, Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.
   pageSize: integer, Size of the page. This value can be limited by a server.
   pageToken: string, Page token to continue retrieval. Comes from the previous call to ListDiscoveryConfigs. `order_by` field must not change for subsequent calls.
@@ -824,6 +881,22 @@ 

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -948,6 +1021,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -1060,6 +1136,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -1184,6 +1276,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -1278,6 +1373,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -1402,6 +1513,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 7d0aa14ed5e..3da5384ecde 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -136,7 +136,7 @@

Method Details

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more. When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -440,7 +440,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -803,7 +803,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1096,7 +1096,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1335,7 +1335,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1665,7 +1665,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1958,7 +1958,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2197,7 +2197,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2527,7 +2527,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2820,7 +2820,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3059,7 +3059,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3542,7 +3542,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4554,7 +4554,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -4847,7 +4847,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5086,7 +5086,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5416,7 +5416,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5709,7 +5709,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -5948,7 +5948,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -6278,7 +6278,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -6571,7 +6571,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -6810,7 +6810,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -7293,7 +7293,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -8161,7 +8161,7 @@

Method Details

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect jobs: - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - `trigger_name` - The name of the trigger that created the job. - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * Supported fields for risk analysis jobs: - `state` - RUNNING|CANCELED|FINISHED|FAILED - 'end_time` - Corresponds to the time the job finished. - 'start_time` - Corresponds to the time the job finished. * The operator must be `=` or `!=`. Examples: * inspected_storage = cloud_storage AND state = done * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = done OR state = canceled) * end_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`
@@ -8363,7 +8363,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -8656,7 +8656,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -8895,7 +8895,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9225,7 +9225,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9518,7 +9518,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -9757,7 +9757,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -10087,7 +10087,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -10380,7 +10380,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -10619,7 +10619,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -11102,7 +11102,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 0f3fac7a102..778d909dd11 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -155,6 +155,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -192,6 +208,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -316,6 +348,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -589,12 +624,12 @@

Method Details

"fileClusterType": { # Message used to identify file cluster type being profiled. # The file cluster type. "cluster": "A String", # Cluster type. }, - "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. + "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, ], - "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. + "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, @@ -729,6 +764,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -766,6 +817,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -890,6 +957,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -1163,12 +1233,12 @@

Method Details

"fileClusterType": { # Message used to identify file cluster type being profiled. # The file cluster type. "cluster": "A String", # Cluster type. }, - "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. + "fileExtensionsScanned": [ # A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, ], - "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. + "fileExtensionsSeen": [ # A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content. { # Information regarding the discovered file extension. "fileExtension": "A String", # The file extension if set. (aka .pdf, .jpg, .txt) }, diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html index 91f2066d7e6..598aa4cd82c 100644 --- a/docs/dyn/dlp_v2.projects.locations.image.html +++ b/docs/dyn/dlp_v2.projects.locations.image.html @@ -91,7 +91,7 @@

Method Details

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more. When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
 
 Args:
-  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
index 6d11f8b6ee7..b7c6bac7d69 100644
--- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
@@ -106,7 +106,7 @@ 

Method Details

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -719,7 +719,7 @@ 

Method Details

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
index 91f5b1242e9..4c64a47ddb7 100644
--- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
@@ -303,7 +303,7 @@ 

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -596,7 +596,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -835,7 +835,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1165,7 +1165,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1458,7 +1458,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -1697,7 +1697,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2027,7 +2027,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2320,7 +2320,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -2559,7 +2559,7 @@

Method Details

"key": "A String", # Required. A 128/192/256 bit key. }, }, - "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/ + "customAlphabet": "A String", # This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\:;"'<,>.?/`` "radix": 42, # The native way to select the alphabet. Must be in the range [2, 95]. "surrogateInfoType": { # Type of information detected by the API. # The custom infoType to annotate the surrogate with. This annotation will be applied to the surrogate by prefixing it with the name of the custom infoType followed by the number of characters comprising the surrogate. The following scheme defines the format: info_type_name(surrogate_character_count):surrogate For example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and the surrogate is 'abc', the full replacement value will be: 'MY_TOKEN_INFO_TYPE(3):abc' This annotation identifies the surrogate when inspecting content using the custom infoType [`SurrogateType`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/InspectConfig#surrogatetype). This facilitates reversal of the surrogate when it occurs in free text. In order for inspection to work properly, the name of this infoType must not occur naturally anywhere in your data; otherwise, inspection may find a surrogate that does not correspond to an actual identifier. Therefore, choose your custom infoType name carefully after considering what your data looks like. One way to select a name that has a high chance of yielding reliable detection is to include one or more unicode characters that are highly improbable to exist in your data. For example, assuming your data is entered from a regular ASCII keyboard, the symbol with the hex code point 29DD might be used like so: ⧝MY_TOKEN_TYPE "name": "A String", # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`. @@ -3042,7 +3042,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -3827,7 +3827,7 @@

Method Details

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -4152,7 +4152,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4504,7 +4504,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4878,7 +4878,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -4993,7 +4993,7 @@

Method Details

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values for inspect triggers: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters.
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.
@@ -5334,7 +5334,7 @@ 

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -5703,7 +5703,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, @@ -6054,7 +6054,7 @@

Method Details

"enableAutoPopulationOfTimespanConfig": True or False, # When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger or the timespan end_time used in the last run of the JobTrigger. **For BigQuery** Inspect jobs triggered by automatic population will scan data that is at least three hours old when the job starts. This is because streaming buffer rows are not read during inspection and reading up to the current timestamp will result in skipped rows. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#recently-streamed-data) related to this operation. "endTime": "A String", # Exclude files, tables, or rows newer than this value. If not set, no upper time limit is applied. "startTime": "A String", # Exclude files, tables, or rows older than this value. If not set, no lower time limit is applied. - "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + "timestampField": { # General identifier of a data field in a storage service. # Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. "name": "A String", # Name describing the field. }, }, diff --git a/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html b/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html index 54020c6a213..544902fee20 100644 --- a/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.projects.locations.storedInfoTypes.html @@ -106,7 +106,7 @@

Method Details

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -468,7 +468,7 @@ 

Method Details

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
index 73ca6db525b..06cbeac1ded 100644
--- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
+++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
@@ -155,6 +155,22 @@ 

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -192,6 +208,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -316,6 +348,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. @@ -673,6 +708,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "inspectTemplates": [ # Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency. @@ -710,6 +761,22 @@

Method Details

}, "topic": "A String", # Cloud Pub/Sub topic to send notifications to. Format is projects/{project}/topics/{topic}. }, + "tagResources": { # If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. # Tags the profiled resources with the specified tag values. + "lowerDataRiskToLow": True or False, # Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + "profileGenerationsToTag": [ # The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + "A String", + ], + "tagConditions": [ # The tags to associate with different conditions. + { # The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + "sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Conditions attaching the tag to a resource on its profile having this sensitivity score. + "score": "A String", # The sensitivity score applied to the resource. + }, + "tag": { # A value of a tag. # The tag value to attach to resources. + "namespacedValue": "A String", # The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod". + }, + }, + ], + }, }, ], "createTime": "A String", # Output only. The creation timestamp of a DiscoveryConfig. @@ -834,6 +901,9 @@

Method Details

}, }, "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. + "inspectTemplateModifiedCadence": { # The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. # Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + "frequency": "A String", # How frequently data profiles can be updated when the template is modified. Defaults to never. + }, "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 changed. Defaults to never. "schemaModifiedCadence": { # How frequently 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. diff --git a/docs/dyn/dlp_v2.projects.storedInfoTypes.html b/docs/dyn/dlp_v2.projects.storedInfoTypes.html index fca4329a343..17a09a4b201 100644 --- a/docs/dyn/dlp_v2.projects.storedInfoTypes.html +++ b/docs/dyn/dlp_v2.projects.storedInfoTypes.html @@ -106,7 +106,7 @@

Method Details

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -468,7 +468,7 @@ 

Method Details

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.
 
 Args:
-  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
+  parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 (required)
   locationId: string, Deprecated. This field has no effect.
   orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.
   pageSize: integer, Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html
index 5ad91867d35..c2601b5f483 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.html
@@ -535,6 +535,7 @@ 

Method Details

"gcsUri": "A String", # The Cloud Storage object uri. "mimeType": "A String", # An IANA MIME type (RFC6838) of the content. }, + "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. "chunks": [ # List of chunks. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 043d1daa237..cadec2de2c2 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -627,6 +627,7 @@

Method Details

"gcsUri": "A String", # The Cloud Storage object uri. "mimeType": "A String", # An IANA MIME type (RFC6838) of the content. }, + "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. "chunks": [ # List of chunks. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 88e0fdd90e0..a24721ca50a 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -1502,6 +1502,7 @@

Method Details

"gcsUri": "A String", # The Cloud Storage object uri. "mimeType": "A String", # An IANA MIME type (RFC6838) of the content. }, + "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. "chunks": [ # List of chunks. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 25286e20191..5fce6daddc4 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -1659,6 +1659,7 @@

Method Details

"gcsUri": "A String", # The Cloud Storage object uri. "mimeType": "A String", # An IANA MIME type (RFC6838) of the content. }, + "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. "chunks": [ # List of chunks. diff --git a/docs/dyn/drive_v2.changes.html b/docs/dyn/drive_v2.changes.html index 88cd32e18c1..f5a5b31a27c 100644 --- a/docs/dyn/drive_v2.changes.html +++ b/docs/dyn/drive_v2.changes.html @@ -337,7 +337,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -378,8 +378,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -876,7 +876,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -917,8 +917,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index e3cf26b8997..bf31d95af98 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -323,7 +323,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -364,8 +364,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -726,7 +726,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -767,8 +767,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -1215,7 +1215,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -1256,8 +1256,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -1632,7 +1632,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -1673,8 +1673,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -2038,7 +2038,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -2079,8 +2079,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -2458,7 +2458,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -2499,8 +2499,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -3035,7 +3035,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -3076,8 +3076,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -3448,7 +3448,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -3489,8 +3489,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -3847,7 +3847,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -3888,8 +3888,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -4246,7 +4246,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -4287,8 +4287,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -4645,7 +4645,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -4686,8 +4686,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -5035,7 +5035,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -5076,8 +5076,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -5450,7 +5450,7 @@

Method Details

"trashed": True or False, # Whether this file has been trashed. This label applies to all users accessing the file; however, only owners are allowed to see and untrash files. "viewed": True or False, # Whether this file has been viewed by this user. }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -5491,8 +5491,8 @@

Method Details

}, }, ], - "parents": [ # Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. diff --git a/docs/dyn/drive_v2.parents.html b/docs/dyn/drive_v2.parents.html index 28698de66df..efd67514680 100644 --- a/docs/dyn/drive_v2.parents.html +++ b/docs/dyn/drive_v2.parents.html @@ -125,7 +125,7 @@

Method Details

Returns: An object of the form: - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -143,7 +143,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. +{ # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -162,7 +162,7 @@

Method Details

Returns: An object of the form: - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. @@ -188,7 +188,7 @@

Method Details

{ # A list of a file's parents. "etag": "A String", # The ETag of the list. "items": [ # The list of parents. - { # A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. + { # A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent. "id": "A String", # The ID of the parent. "isRoot": True or False, # Output only. Whether or not the parent is the root folder. "kind": "drive#parentReference", # Output only. This is always `drive#parentReference`. diff --git a/docs/dyn/drive_v2.revisions.html b/docs/dyn/drive_v2.revisions.html index 514bb891dd9..6e6aa32a3bf 100644 --- a/docs/dyn/drive_v2.revisions.html +++ b/docs/dyn/drive_v2.revisions.html @@ -139,7 +139,7 @@

Method Details

"fileSize": "A String", # Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive. "id": "A String", # Output only. The ID of the revision. "kind": "drive#revision", # Output only. This is always `drive#revision`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -191,7 +191,7 @@

Method Details

"fileSize": "A String", # Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive. "id": "A String", # Output only. The ID of the revision. "kind": "drive#revision", # Output only. This is always `drive#revision`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -253,7 +253,7 @@

Method Details

"fileSize": "A String", # Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive. "id": "A String", # Output only. The ID of the revision. "kind": "drive#revision", # Output only. This is always `drive#revision`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -293,7 +293,7 @@

Method Details

"fileSize": "A String", # Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive. "id": "A String", # Output only. The ID of the revision. "kind": "drive#revision", # Output only. This is always `drive#revision`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -336,7 +336,7 @@

Method Details

"fileSize": "A String", # Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive. "id": "A String", # Output only. The ID of the revision. "kind": "drive#revision", # Output only. This is always `drive#revision`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. @@ -376,7 +376,7 @@

Method Details

"fileSize": "A String", # Output only. The size of the revision in bytes. This will only be populated on files with content stored in Drive. "id": "A String", # Output only. The ID of the revision. "kind": "drive#revision", # Output only. This is always `drive#revision`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. "isAuthenticatedUser": True or False, # Output only. Whether this user is the same as the authenticated user for whom the request was made. diff --git a/docs/dyn/drive_v3.changes.html b/docs/dyn/drive_v3.changes.html index 8f777b74a14..c4d82b2228e 100644 --- a/docs/dyn/drive_v3.changes.html +++ b/docs/dyn/drive_v3.changes.html @@ -352,7 +352,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -382,7 +382,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index ee11c21a764..46e485c7d12 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -296,7 +296,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -326,7 +326,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -592,7 +592,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -622,7 +622,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -881,7 +881,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -911,7 +911,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -1180,7 +1180,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -1210,7 +1210,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -1563,7 +1563,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -1593,7 +1593,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -1899,7 +1899,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -1929,7 +1929,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -2371,7 +2371,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -2401,7 +2401,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. @@ -2671,7 +2671,7 @@

Method Details

}, ], }, - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -2701,7 +2701,7 @@

Method Details

"photoLink": "A String", # Output only. A link to the user's profile photo, if available. }, ], - "parents": [ # The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. + "parents": [ # The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list. "A String", ], "permissionIds": [ # Output only. List of permission IDs for users with access to this file. diff --git a/docs/dyn/drive_v3.revisions.html b/docs/dyn/drive_v3.revisions.html index df6a0d42500..8bc0b8f7c8f 100644 --- a/docs/dyn/drive_v3.revisions.html +++ b/docs/dyn/drive_v3.revisions.html @@ -138,7 +138,7 @@

Method Details

"id": "A String", # Output only. The ID of the revision. "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. "kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -204,7 +204,7 @@

Method Details

"id": "A String", # Output only. The ID of the revision. "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. "kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -257,7 +257,7 @@

Method Details

"id": "A String", # Output only. The ID of the revision. "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. "kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. @@ -291,7 +291,7 @@

Method Details

"id": "A String", # Output only. The ID of the revision. "keepForever": True or False, # Whether to keep this revision forever, even if it is no longer the head revision. If not set, the revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum of 200 revisions for a file. This field is only applicable to files with binary content in Drive. "kind": "drive#revision", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#revision"`. - "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. + "lastModifyingUser": { # Information about a Drive user. # Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. "kind": "drive#user", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#user"`. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index fbc15730a4a..77a5c05a690 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -240,8 +240,8 @@

Method Details

}, "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. Deprecated. This option is no longer supported. - "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}` + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search data store 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": [ # Optional. Deprecated. Please use rag_resources instead. @@ -487,8 +487,8 @@

Method Details

}, "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. Deprecated. This option is no longer supported. - "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}` + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search data store 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": [ # Optional. Deprecated. Please use rag_resources instead. @@ -857,8 +857,8 @@

Method Details

}, "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. Deprecated. This option is no longer supported. - "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}` + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "datastore": "A String", # Required. Fully-qualified Vertex AI Search data store 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": [ # Optional. Deprecated. Please use rag_resources instead. diff --git a/docs/dyn/gkehub_v1.organizations.locations.fleets.html b/docs/dyn/gkehub_v1.organizations.locations.fleets.html index 9bd8c0f707f..bcce89148d8 100644 --- a/docs/dyn/gkehub_v1.organizations.locations.fleets.html +++ b/docs/dyn/gkehub_v1.organizations.locations.fleets.html @@ -118,6 +118,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/gkehub_v1.projects.locations.fleets.html b/docs/dyn/gkehub_v1.projects.locations.fleets.html index b632f228ca7..f307cc13a10 100644 --- a/docs/dyn/gkehub_v1.projects.locations.fleets.html +++ b/docs/dyn/gkehub_v1.projects.locations.fleets.html @@ -121,6 +121,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -228,6 +236,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -276,6 +292,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -332,6 +356,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/gkehub_v1alpha.organizations.locations.fleets.html b/docs/dyn/gkehub_v1alpha.organizations.locations.fleets.html index 1494e7aa0a4..ba6f7f337c4 100644 --- a/docs/dyn/gkehub_v1alpha.organizations.locations.fleets.html +++ b/docs/dyn/gkehub_v1alpha.organizations.locations.fleets.html @@ -118,6 +118,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.fleets.html b/docs/dyn/gkehub_v1alpha.projects.locations.fleets.html index 9b1d34c3a2b..1f9478921b8 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.fleets.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.fleets.html @@ -121,6 +121,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -228,6 +236,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -276,6 +292,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -332,6 +356,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/gkehub_v1beta.organizations.locations.fleets.html b/docs/dyn/gkehub_v1beta.organizations.locations.fleets.html index 69ffe862524..6d1f9d6e7a4 100644 --- a/docs/dyn/gkehub_v1beta.organizations.locations.fleets.html +++ b/docs/dyn/gkehub_v1beta.organizations.locations.fleets.html @@ -118,6 +118,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.fleets.html b/docs/dyn/gkehub_v1beta.projects.locations.fleets.html index b03e38bf47c..0b3d30e6fa5 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.fleets.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.fleets.html @@ -121,6 +121,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -228,6 +236,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -276,6 +292,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -332,6 +356,14 @@

Method Details

}, ], }, + "compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + "complianceStandards": [ # List of enabled compliance standards. + { + "standard": "A String", # Name of the compliance standard. + }, + ], + "mode": "A String", # Defines the enablement mode for Compliance Posture. + }, "securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. diff --git a/docs/dyn/gkehub_v2.html b/docs/dyn/gkehub_v2.html new file mode 100644 index 00000000000..939ccdc160c --- /dev/null +++ b/docs/dyn/gkehub_v2.html @@ -0,0 +1,111 @@ + + + +

GKE Hub 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/gkehub_v2.projects.html b/docs/dyn/gkehub_v2.projects.html new file mode 100644 index 00000000000..7c8bc17af0c --- /dev/null +++ b/docs/dyn/gkehub_v2.projects.html @@ -0,0 +1,91 @@ + + + +

GKE Hub 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/gkehub_v2.projects.locations.html b/docs/dyn/gkehub_v2.projects.locations.html new file mode 100644 index 00000000000..f546aff0aa0 --- /dev/null +++ b/docs/dyn/gkehub_v2.projects.locations.html @@ -0,0 +1,176 @@ + + + +

GKE Hub API . projects . locations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive 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:
+
+    { # The response message for Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ 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/gkehub_v2.projects.locations.operations.html b/docs/dyn/gkehub_v2.projects.locations.operations.html new file mode 100644 index 00000000000..a8a406aad61 --- /dev/null +++ b/docs/dyn/gkehub_v2.projects.locations.operations.html @@ -0,0 +1,214 @@ + + + +

GKE Hub API . projects . locations . operations

+

Instance Methods

+

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

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

+

+ 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.

+

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

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  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.
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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_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/gkehub_v2beta.html b/docs/dyn/gkehub_v2beta.html new file mode 100644 index 00000000000..040ccbbeda0 --- /dev/null +++ b/docs/dyn/gkehub_v2beta.html @@ -0,0 +1,111 @@ + + + +

GKE Hub 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/gkehub_v2beta.projects.html b/docs/dyn/gkehub_v2beta.projects.html new file mode 100644 index 00000000000..b8d8ea18ce4 --- /dev/null +++ b/docs/dyn/gkehub_v2beta.projects.html @@ -0,0 +1,91 @@ + + + +

GKE Hub 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/gkehub_v2beta.projects.locations.html b/docs/dyn/gkehub_v2beta.projects.locations.html new file mode 100644 index 00000000000..b10637165ca --- /dev/null +++ b/docs/dyn/gkehub_v2beta.projects.locations.html @@ -0,0 +1,176 @@ + + + +

GKE Hub API . projects . locations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets information about a location.

+

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

+

Lists information about the supported locations for this service.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets information about a location.
+
+Args:
+  name: string, Resource name for the location. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A resource that represents a Google Cloud location.
+  "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+  "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+    "a_key": "A String",
+  },
+  "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+  "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists information about the supported locations for this service.
+
+Args:
+  name: string, The resource that owns the locations collection, if applicable. (required)
+  filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+  pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive 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:
+
+    { # The response message for Locations.ListLocations.
+  "locations": [ # A list of locations that matches the specified filter in the request.
+    { # A resource that represents a Google Cloud location.
+      "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+      "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+        "a_key": "A String",
+      },
+      "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+      "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+    },
+  ],
+  "nextPageToken": "A String", # The standard List next-page token.
+}
+
+ +
+ 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/gkehub_v2beta.projects.locations.operations.html b/docs/dyn/gkehub_v2beta.projects.locations.operations.html new file mode 100644 index 00000000000..e44d67cd1a1 --- /dev/null +++ b/docs/dyn/gkehub_v2beta.projects.locations.operations.html @@ -0,0 +1,214 @@ + + + +

GKE Hub API . projects . locations . operations

+

Instance Methods

+

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

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

+

+ 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.

+

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

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  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.
+
+ +
+ 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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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_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/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html index 6630f2d2e31..bdd51a8a71d 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html @@ -83,6 +83,9 @@

Instance Methods

Consent_enforcement_status(name, x__xgafv=None)

Returns the consent enforcement status of a single consent resource. On success, the response body contains a JSON-encoded representation of a `Parameters` (http://hl7.org/fhir/parameters.html) FHIR resource, containing the current enforcement status. Does not support DSTU2.

+

+ Encounter_everything(name, x__xgafv=None, x_count=None, x_page_token=None, x_since=None, x_type=None)

+

Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/encounter-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/implement/standards/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" extension.

Observation_lastn(parent, x__xgafv=None)

Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

@@ -231,6 +234,35 @@

Method Details

}
+
+ Encounter_everything(name, x__xgafv=None, x_count=None, x_page_token=None, x_since=None, x_type=None) +
Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/encounter-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/implement/standards/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the "http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter" extension.
+
+Args:
+  name: string, Required. Name of the Encounter resource for which the information is required. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+  x_count: integer, Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
+  x_page_token: string, Optional. Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.
+  x_since: string, Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
+  x_type: string, Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple `_type` parameters isn't supported. For example, the result of `_type=Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter` instead.
+
+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.
+    },
+  ],
+}
+
+
Observation_lastn(parent, x__xgafv=None)
Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.
diff --git a/docs/dyn/index.md b/docs/dyn/index.md
index 4514ec254c4..7a895259494 100644
--- a/docs/dyn/index.md
+++ b/docs/dyn/index.md
@@ -14,10 +14,6 @@
 * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/accesscontextmanager_v1.html)
 
 
-## acmedns
-* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/acmedns_v1.html)
-
-
 ## addressvalidation
 * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/addressvalidation_v1.html)
 
@@ -672,7 +668,9 @@
 * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/gkehub_v1alpha.html)
 * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/gkehub_v1beta.html)
 * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/gkehub_v1beta1.html)
+* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/gkehub_v2.html)
 * [v2alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/gkehub_v2alpha.html)
+* [v2beta](http://googleapis.github.io/google-api-python-client/docs/dyn/gkehub_v2beta.html)
 
 
 ## gkeonprem
diff --git a/docs/dyn/integrations_v1.projects.locations.certificates.html b/docs/dyn/integrations_v1.projects.locations.certificates.html
index 19762820255..f407f62bb43 100644
--- a/docs/dyn/integrations_v1.projects.locations.certificates.html
+++ b/docs/dyn/integrations_v1.projects.locations.certificates.html
@@ -112,7 +112,7 @@ 

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -136,7 +136,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -185,7 +185,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -222,7 +222,7 @@

Method Details

"certificates": [ # The list of Certificates retrieved. { # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -265,7 +265,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -290,7 +290,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key diff --git a/docs/dyn/integrations_v1.projects.locations.connections.html b/docs/dyn/integrations_v1.projects.locations.connections.html index 51436ef0f83..89bd02d41d5 100644 --- a/docs/dyn/integrations_v1.projects.locations.connections.html +++ b/docs/dyn/integrations_v1.projects.locations.connections.html @@ -147,6 +147,7 @@

Method Details

{ # Response containing Connections listed by region. "connections": [ # Connections. { # Connection represents an instance of connector. + "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -235,11 +236,13 @@

Method Details

"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version. "connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections. "deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun + "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration. "hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config. "cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling. "memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. }, "internalclientRatelimitThreshold": "A String", # Output only. Max QPS supported for internal requests originating from Connd. + "maxInstanceRequestConcurrency": 42, # Output only. Max instance request concurrency. "ratelimitThreshold": "A String", # Output only. Max QPS supported by the connector version before throttling of requests. "resourceLimits": { # Resource limits defined for connection pods of a given connector type. # Output only. System resource limits. "cpu": "A String", # Output only. CPU limit. @@ -472,6 +475,7 @@

Method Details

"updateTime": "A String", # Output only. Timestamp when the webhook was last updated. }, }, + "host": "A String", # Output only. The name of the Hostname of the Service Directory service with TLS. "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} "isTrustedTester": True or False, # Output only. Is trusted tester program enabled for the project. "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources @@ -533,6 +537,7 @@

Method Details

}, "subscriptionType": "A String", # Output only. This subscription type enum states the subscription type of the project. "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not. + "tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS. "updateTime": "A String", # Output only. Updated time. }, ], diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.executions.html b/docs/dyn/integrations_v1.projects.locations.integrations.executions.html index b03698f258f..4f7034c7248 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.executions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.executions.html @@ -94,9 +94,6 @@

Instance Methods

list_next()

Retrieves the next page of results.

-

- replay(name, body=None, x__xgafv=None)

-

Re-execute an existing execution, with same request parameters and execution strategy

Method Details

close() @@ -145,7 +142,8 @@

Method Details

"directSubExecutions": [ # Direct sub executions of the following Execution. # Object with schema name: GoogleCloudIntegrationsV1alphaExecution ], - "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11 # The execution info about this event. + "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event. + "cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation. "eventAttemptStats": [ { "endTime": "A String", # The end time of the event execution for current attempt. @@ -559,7 +557,7 @@

Method Details

orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "create_time". pageSize: integer, Optional. The size of entries in the response. pageToken: string, Optional. The token returned in the previous response. - readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned. + readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency. snapshotMetadataWithoutParams: boolean, Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters. truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out. @@ -573,7 +571,7 @@

Method Details

{ # Response for listing the integration execution data. "executionInfos": [ # Required. The detailed information of requested executions. - { # Contains all the execution details for a workflow instance. Next available id: 26 + { # Contains all the execution details for a workflow instance. Next available id: 27 "clientId": "A String", # The event data user sends as request. "cloudLoggingDetails": { # Cloud Logging details, selected by the user for the integration version (workflow). This message field will be also used in ExecutionInfo, to indicate the CloudLoggingDetails config at the time of workflow (integration version) execution, since this field value can be changed for an unpublished workflow. # Cloud Logging details for execution info "cloudLoggingSeverity": "A String", # Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed. @@ -593,7 +591,8 @@

Method Details

"taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level. }, ], - "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11 # The execution info about this event. + "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event. + "cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation. "eventAttemptStats": [ { "endTime": "A String", # The end time of the event execution for current attempt. @@ -753,6 +752,7 @@

Method Details

"parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask. "traceId": "A String", # Used to aggregate ExecutionTraceInfo. }, + "integrationVersionUserLabel": "A String", # User-defined label that annotates the executed integration version. "lastModifiedTime": "A String", # Auto-generated. "postMethod": "A String", # The ways user posts this event. "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default. @@ -880,7 +880,8 @@

Method Details

"directSubExecutions": [ # Direct sub executions of the following Execution. # Object with schema name: GoogleCloudIntegrationsV1alphaExecution ], - "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11 # The execution info about this event. + "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event. + "cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation. "eventAttemptStats": [ { "endTime": "A String", # The end time of the event execution for current attempt. @@ -1289,34 +1290,4 @@

Method Details

-
- replay(name, body=None, x__xgafv=None) -
Re-execute an existing execution, with same request parameters and execution strategy
-
-Args:
-  name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for replaying an execution Next ID: 3
-  "replayReason": "A String", # Optional. The user provided reason for replaying the execution.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for replaying an execution Next ID: 4
-  "executionId": "A String", # The id of the execution corresponding to this run of integration.
-  "outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. The parameters would only be present in case of synchrounous execution Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
-    "a_key": "", # Properties of the object.
-  },
-  "replayedExecutionId": "A String", # The execution id which is replayed
-}
-
- \ No newline at end of file diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.html b/docs/dyn/integrations_v1.projects.locations.integrations.html index 5174e81c3f0..bd91fa12021 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.html @@ -716,6 +716,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -785,6 +786,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -828,25 +830,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -1528,7 +1513,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html index 49af5b2a6f3..fd05912585d 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html @@ -188,6 +188,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -257,6 +258,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -300,25 +302,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -1000,7 +985,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -1235,6 +1220,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -1304,6 +1290,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -1347,25 +1334,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -2047,7 +2017,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -2351,6 +2321,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -2420,6 +2391,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -2463,25 +2435,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -3163,7 +3118,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -3407,6 +3362,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -3476,6 +3432,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -3519,25 +3476,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -4219,7 +4159,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -4387,7 +4327,7 @@

Method Details

Returns the list of all integration versions in the specified project.
 
 Args:
-  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client". (required)
+  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". (required)
   fieldMask: string, The field mask which specifies the particular data to be returned.
   filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
   orderBy: string, The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
@@ -4466,6 +4406,7 @@ 

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -4535,6 +4476,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -4578,25 +4520,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -5278,7 +5203,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -5531,6 +5456,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -5600,6 +5526,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -5643,25 +5570,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -6343,7 +6253,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -6577,6 +6487,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -6646,6 +6557,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -6689,25 +6601,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -7389,7 +7284,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -7689,6 +7584,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -7758,6 +7654,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -7801,25 +7698,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -8501,7 +8381,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, diff --git a/docs/dyn/integrations_v1.projects.locations.products.certificates.html b/docs/dyn/integrations_v1.projects.locations.products.certificates.html index 9384d05cd30..6d1ba927fba 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.certificates.html +++ b/docs/dyn/integrations_v1.projects.locations.products.certificates.html @@ -112,7 +112,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -136,7 +136,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -185,7 +185,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -222,7 +222,7 @@

Method Details

"certificates": [ # The list of Certificates retrieved. { # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -265,7 +265,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key @@ -290,7 +290,7 @@

Method Details

{ # The certificate definition "certificateStatus": "A String", # Status of the certificate - "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY + "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler "description": "A String", # Description of the certificate "displayName": "A String", # Required. Name of the certificate "name": "A String", # Output only. Auto generated primary key diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html index dd0bad5d7a5..bc07f50e818 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html @@ -79,9 +79,6 @@

Instance Methods

Returns the suspensions Resource.

-

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

-

Cancellation of an execution

close()

Close httplib2 connections.

@@ -98,31 +95,6 @@

Instance Methods

list_next()

Retrieves the next page of results.

Method Details

-
- cancel(name, body=None, x__xgafv=None) -
Cancellation of an execution
-
-Args:
-  name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request for cancelling an execution.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for cancelling an execution.
-  "isCanceled": True or False, # True if cancellation performed successfully
-}
-
-
close()
Close httplib2 connections.
@@ -170,7 +142,8 @@

Method Details

"directSubExecutions": [ # Direct sub executions of the following Execution. # Object with schema name: GoogleCloudIntegrationsV1alphaExecution ], - "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11 # The execution info about this event. + "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event. + "cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation. "eventAttemptStats": [ { "endTime": "A String", # The end time of the event execution for current attempt. @@ -584,7 +557,7 @@

Method Details

orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "create_time". pageSize: integer, Optional. The size of entries in the response. pageToken: string, Optional. The token returned in the previous response. - readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned. + readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency. snapshotMetadataWithoutParams: boolean, Optional. If true, the service will provide execution info with snapshot metadata only i.e. without event parameters. truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out. @@ -598,7 +571,7 @@

Method Details

{ # Response for listing the integration execution data. "executionInfos": [ # Required. The detailed information of requested executions. - { # Contains all the execution details for a workflow instance. Next available id: 26 + { # Contains all the execution details for a workflow instance. Next available id: 27 "clientId": "A String", # The event data user sends as request. "cloudLoggingDetails": { # Cloud Logging details, selected by the user for the integration version (workflow). This message field will be also used in ExecutionInfo, to indicate the CloudLoggingDetails config at the time of workflow (integration version) execution, since this field value can be changed for an unpublished workflow. # Cloud Logging details for execution info "cloudLoggingSeverity": "A String", # Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed. @@ -618,7 +591,8 @@

Method Details

"taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level. }, ], - "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11 # The execution info about this event. + "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event. + "cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation. "eventAttemptStats": [ { "endTime": "A String", # The end time of the event execution for current attempt. @@ -778,6 +752,7 @@

Method Details

"parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask. "traceId": "A String", # Used to aggregate ExecutionTraceInfo. }, + "integrationVersionUserLabel": "A String", # User-defined label that annotates the executed integration version. "lastModifiedTime": "A String", # Auto-generated. "postMethod": "A String", # The ways user posts this event. "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default. @@ -905,7 +880,8 @@

Method Details

"directSubExecutions": [ # Direct sub executions of the following Execution. # Object with schema name: GoogleCloudIntegrationsV1alphaExecution ], - "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11 # The execution info about this event. + "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12 # The execution info about this event. + "cancelReason": "A String", # If the execution is manually canceled, this field will contain the reason for cancellation. "eventAttemptStats": [ { "endTime": "A String", # The end time of the event execution for current attempt. diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.html index 6829b93b917..b6b2e4d47ce 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.html @@ -671,6 +671,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -740,6 +741,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -783,25 +785,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -1483,7 +1468,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html index ff348eb9286..3384846382e 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html @@ -188,6 +188,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -257,6 +258,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -300,25 +302,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -1000,7 +985,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -1235,6 +1220,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -1304,6 +1290,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -1347,25 +1334,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -2047,7 +2017,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -2340,6 +2310,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -2409,6 +2380,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -2452,25 +2424,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -3152,7 +3107,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -3320,7 +3275,7 @@

Method Details

Returns the list of all integration versions in the specified project.
 
 Args:
-  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client". (required)
+  parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". (required)
   fieldMask: string, The field mask which specifies the particular data to be returned.
   filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
   orderBy: string, The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
@@ -3399,6 +3354,7 @@ 

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -3468,6 +3424,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -3511,25 +3468,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -4211,7 +4151,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -4464,6 +4404,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -4533,6 +4474,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -4576,25 +4518,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -5276,7 +5201,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -5510,6 +5435,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -5579,6 +5505,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -5622,25 +5549,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -6322,7 +6232,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -6596,6 +6506,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -6665,6 +6576,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -6708,25 +6620,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -7408,7 +7303,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -7682,6 +7577,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -7751,6 +7647,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -7794,25 +7691,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -8494,7 +8374,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, diff --git a/docs/dyn/integrations_v1.projects.locations.templates.html b/docs/dyn/integrations_v1.projects.locations.templates.html index c16221890c7..a16b5ad1e41 100644 --- a/docs/dyn/integrations_v1.projects.locations.templates.html +++ b/docs/dyn/integrations_v1.projects.locations.templates.html @@ -139,7 +139,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -223,6 +222,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -292,6 +292,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -335,25 +336,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -1035,7 +1019,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -1263,6 +1247,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -1332,6 +1317,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -1375,25 +1361,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -2075,7 +2044,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -2259,7 +2228,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -2343,6 +2311,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -2412,6 +2381,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -2455,25 +2425,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -3155,7 +3108,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -3383,6 +3336,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -3452,6 +3406,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -3495,25 +3450,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -4195,7 +4133,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -4428,7 +4366,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -4512,6 +4449,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -4581,6 +4519,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -4624,25 +4563,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -5324,7 +5246,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -5552,6 +5474,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -5621,6 +5544,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -5664,25 +5588,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -6364,7 +6271,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -6628,6 +6535,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -6697,6 +6605,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -6740,25 +6649,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -7440,7 +7332,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -7665,6 +7557,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -7734,6 +7627,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -7777,25 +7671,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -8477,7 +8354,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -8669,7 +8546,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -8753,6 +8629,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -8822,6 +8699,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -8865,25 +8743,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -9565,7 +9426,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -9793,6 +9654,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -9862,6 +9724,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -9905,25 +9768,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -10605,7 +10451,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -10807,7 +10653,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -10891,6 +10736,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -10960,6 +10806,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -11003,25 +10850,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -11703,7 +11533,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -11931,6 +11761,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -12000,6 +11831,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -12043,25 +11875,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -12743,7 +12558,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -12928,7 +12743,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -13012,6 +12826,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -13081,6 +12896,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -13124,25 +12940,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -13824,7 +13623,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -14052,6 +13851,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -14121,6 +13921,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -14164,25 +13965,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -14864,7 +14648,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -15063,7 +14847,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -15147,6 +14930,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -15216,6 +15000,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -15259,25 +15044,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -15959,7 +15727,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -16187,6 +15955,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -16256,6 +16025,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -16299,25 +16069,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -16999,7 +16752,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -17269,7 +17022,6 @@

Method Details

"categories": [ # Required. Categories associated with the Template. The categories listed below will be utilized for the Template listing. "A String", ], - "clientId": "A String", # Required. Client id with which Template is associated "components": [ # Optional. Components being used in the template. This could be used to categorize and filter. { # Define the components that are present in a template. "name": "A String", # Optional. Name of the component. @@ -17353,6 +17105,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -17422,6 +17175,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -17465,25 +17219,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -18165,7 +17902,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -18393,6 +18130,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -18462,6 +18200,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -18505,25 +18244,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -19205,7 +18927,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -19473,6 +19195,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -19542,6 +19265,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -19585,25 +19309,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -20285,7 +19992,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, @@ -20510,6 +20217,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -20579,6 +20287,7 @@

Method Details

}, "stringValue": "A String", # String. }, + "description": "A String", # Optional. Description of the parameter. "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName". "inputOutputType": "A String", # Specifies the input/output type for the parameter. "isTransient": True or False, # Whether this parameter is a transient parameter. @@ -20622,25 +20331,8 @@

Method Details

"isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable. "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. # See "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key. - "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc. - "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization. - "logType": [ # To which type(s) of logs the sanitize options apply. - "A String", - ], - "privacy": "A String", - "sanitizeType": "A String", - }, "seedPeriod": "A String", "seedScope": "A String", - "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length. - "logAction": "A String", - "logType": [ # To which type(s) of logs the limits apply. - "A String", - ], - "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated. - "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened. - "shortenerType": "A String", - }, }, "masked": True or False, # True if this workflow parameter should be masked in the logs "readOnly": True or False, # Used to indicate if the ParameterEntry is a read only field or not. @@ -21322,7 +21014,7 @@

Method Details

}, ], "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose. - "triggerId": "A String", # Optional. The backend trigger ID. + "triggerId": "A String", # Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {"Trigger name": TRIGGER_NAME} "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI. "triggerType": "A String", # Optional. Type of trigger }, diff --git a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html index c718ebf7113..21bf4b22f65 100644 --- a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html +++ b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html @@ -148,7 +148,16 @@

Method Details

], "destinationStatuses": [ # Output only. The statuses of the destinations. { # The destination status. + "approvedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + "A String", + ], "destination": "A String", # The name of the destination. + "disapprovedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + "A String", + ], + "pendingCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + "A String", + ], "status": "A String", # The status of the destination. }, ], @@ -218,7 +227,16 @@

Method Details

], "destinationStatuses": [ # Output only. The statuses of the destinations. { # The destination status. + "approvedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + "A String", + ], "destination": "A String", # The name of the destination. + "disapprovedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + "A String", + ], + "pendingCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + "A String", + ], "status": "A String", # The status of the destination. }, ], @@ -294,7 +312,16 @@

Method Details

], "destinationStatuses": [ # Output only. The statuses of the destinations. { # The destination status. + "approvedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + "A String", + ], "destination": "A String", # The name of the destination. + "disapprovedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + "A String", + ], + "pendingCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + "A String", + ], "status": "A String", # The status of the destination. }, ], @@ -353,7 +380,16 @@

Method Details

], "destinationStatuses": [ # Output only. The statuses of the destinations. { # The destination status. + "approvedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + "A String", + ], "destination": "A String", # The name of the destination. + "disapprovedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + "A String", + ], + "pendingCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + "A String", + ], "status": "A String", # The status of the destination. }, ], diff --git a/docs/dyn/manufacturers_v1.accounts.products.html b/docs/dyn/manufacturers_v1.accounts.products.html index adfe5f69c57..de07a76fda8 100644 --- a/docs/dyn/manufacturers_v1.accounts.products.html +++ b/docs/dyn/manufacturers_v1.accounts.products.html @@ -210,6 +210,9 @@

Method Details

"includedDestination": [ # A list of included destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 "A String", ], + "intendedCountry": [ # Optional. List of countries to show this product in. Countries provided in this attribute will override any of the countries configured at feed level. The values should be: the [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries in which this item will be shown. + "A String", + ], "itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. @@ -375,10 +378,20 @@

Method Details

"contentLanguage": "A String", # The content language of the product as a two-letter ISO 639-1 language code (for example, en). "destinationStatuses": [ # The status of the destinations. { # The destination status. + "approvedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + "A String", + ], "destination": "A String", # The name of the destination. + "disapprovedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + "A String", + ], + "pendingCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + "A String", + ], "status": "A String", # The status of the destination. }, ], + "feedLabel": "A String", # Optional. The feed label for the product. "issues": [ # A server-generated list of issues associated with the product. { # Product issue. "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. @@ -498,6 +511,9 @@

Method Details

"includedDestination": [ # A list of included destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 "A String", ], + "intendedCountry": [ # Optional. List of countries to show this product in. Countries provided in this attribute will override any of the countries configured at feed level. The values should be: the [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries in which this item will be shown. + "A String", + ], "itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. @@ -663,10 +679,20 @@

Method Details

"contentLanguage": "A String", # The content language of the product as a two-letter ISO 639-1 language code (for example, en). "destinationStatuses": [ # The status of the destinations. { # The destination status. + "approvedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + "A String", + ], "destination": "A String", # The name of the destination. + "disapprovedCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + "A String", + ], + "pendingCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + "A String", + ], "status": "A String", # The status of the destination. }, ], + "feedLabel": "A String", # Optional. The feed label for the product. "issues": [ # A server-generated list of issues associated with the product. { # Product issue. "applicableCountries": [ # Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. @@ -786,6 +812,9 @@

Method Details

"includedDestination": [ # A list of included destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 "A String", ], + "intendedCountry": [ # Optional. List of countries to show this product in. Countries provided in this attribute will override any of the countries configured at feed level. The values should be: the [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries in which this item will be shown. + "A String", + ], "itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html index 609e97b01a7..68e608188bd 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html @@ -300,11 +300,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -343,6 +354,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -873,11 +885,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -916,6 +939,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -1478,11 +1502,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -1521,6 +1556,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -2064,11 +2100,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -2107,6 +2154,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -2652,11 +2700,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -2695,6 +2754,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -3220,11 +3280,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -3263,6 +3334,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -3787,11 +3859,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -3830,6 +3913,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index b23239c5367..90595065192 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -240,7 +240,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -457,7 +468,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -614,7 +636,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -779,7 +812,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index bb969be8896..2cc2a792602 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -469,7 +469,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -488,6 +499,11 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "monthlyCostGcveProtected": { # Represents an amount of money with its currency type. # Output only. GCVE Protected nodes cost for this preference set. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -503,6 +519,11 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "monthlyCostPortableVmwareLicense": { # Represents an amount of money with its currency type. # Output only. VMware portable license monthly cost for this preference set. Only present for VMware target with portable license service type. This cost is not paid to google, but is an estimate of license costs paid to VMware. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, "monthlyCostStorage": { # Represents an amount of money with its currency type. # Output only. Storage monthly cost for this preference set. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -643,7 +664,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -1220,7 +1252,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -1239,6 +1282,11 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "monthlyCostGcveProtected": { # Represents an amount of money with its currency type. # Output only. GCVE Protected nodes cost for this preference set. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -1254,6 +1302,11 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "monthlyCostPortableVmwareLicense": { # Represents an amount of money with its currency type. # Output only. VMware portable license monthly cost for this preference set. Only present for VMware target with portable license service type. This cost is not paid to google, but is an estimate of license costs paid to VMware. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, "monthlyCostStorage": { # Represents an amount of money with its currency type. # Output only. Storage monthly cost for this preference set. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -1394,7 +1447,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -1912,7 +1976,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, @@ -1931,6 +2006,11 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "monthlyCostGcveProtected": { # Represents an amount of money with its currency type. # Output only. GCVE Protected nodes cost for this preference set. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -1946,6 +2026,11 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "monthlyCostPortableVmwareLicense": { # Represents an amount of money with its currency type. # Output only. VMware portable license monthly cost for this preference set. Only present for VMware target with portable license service type. This cost is not paid to google, but is an estimate of license costs paid to VMware. + "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. + "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + }, "monthlyCostStorage": { # Represents an amount of money with its currency type. # Output only. Storage monthly cost for this preference set. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. @@ -2086,7 +2171,18 @@

Method Details

"vmwareEnginePreferences": { # The user preferences relating to Google Cloud VMware Engine target platform. # Preferences concerning insights and recommendations for Google Cloud VMware Engine. "commitmentPlan": "A String", # Commitment plan to consider when calculating costs for virtual machine insights and recommendations. If you are unsure which value to set, a 3 year commitment plan is often a good value to start with. "cpuOvercommitRatio": 3.14, # CPU overcommit ratio. Acceptable values are between 1.0 and 8.0, with 0.1 increment. + "licenseDiscountPercentage": 3.14, # Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE. + "machinePreferences": { # The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions. # Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine. + "allowedMachineSeries": [ # Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series. + { # A machine series, for a target product (e.g. Compute Engine, Google Cloud VMware Engine). + "code": "A String", # Code to identify a machine series. Consult this for more details on the available series for Compute Engine: https://cloud.google.com/compute/docs/machine-resource#machine_type_comparison Consult this for more details on the available series for Google Cloud VMware Engine: https://cloud.google.com/vmware-engine/pricing + }, + ], + "protectedNodes": "A String", # Optional. Whether to use VMware Engine Protected offering. + "storageOnlyNodes": "A String", # Optional. Whether to use storage-only nodes, if those are available. + }, "memoryOvercommitRatio": 3.14, # Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0. + "serviceType": "A String", # Optional. VMWare Service Type (Fully Licensed or Portable License). "storageDeduplicationCompressionRatio": 3.14, # The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0. }, }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html index f4e50fe2ea6..66cffa064d6 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html @@ -199,11 +199,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -242,6 +253,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, @@ -639,11 +651,22 @@

Method Details

"instances": [ # Optional. List of database instances. { # Details of a database instance. "instanceName": "A String", # The instance's name. + "network": { # Network details of a database instance. # Optional. Networking details. + "hostNames": [ # Optional. The instance's host names. + "A String", + ], + "ipAddresses": [ # Optional. The instance's IP addresses. + "A String", + ], + "primaryMacAddress": "A String", # Optional. The instance's primary MAC address. + }, "role": "A String", # The instance role in the database engine. }, ], "memoryBytes": "A String", # Optional. Total memory in bytes. "memoryLimitBytes": "A String", # Optional. Total memory in bytes limited by db deployment. + "physicalCoreCount": 42, # Optional. Number of total physical cores. + "physicalCoreLimit": 42, # Optional. Number of total physical cores limited by db deployment. }, "version": "A String", # The database deployment version. }, @@ -682,6 +705,7 @@

Method Details

}, "schemaName": "A String", # The name of the schema. "sqlServer": { # Specific details for a SqlServer database. # Details of a SqlServer schema. + "clrObjectCount": 42, # Optional. SqlServer number of CLR objects. }, "tablesSizeBytes": "A String", # The total size of tables in bytes. }, diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html index fb27dc752db..ab3ebe6e25e 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html @@ -538,6 +538,9 @@

Method Details

"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. "A String", ], + "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html index 280ea5518dc..0a4b422bba3 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html @@ -157,6 +157,9 @@

Method Details

"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. "A String", ], + "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. @@ -302,6 +305,9 @@

Method Details

"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. "A String", ], + "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. @@ -436,6 +442,9 @@

Method Details

"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. "A String", ], + "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. @@ -529,6 +538,9 @@

Method Details

"includeExportRanges": [ # Optional. IP ranges allowed to be included from peering. "A String", ], + "producerVpcSpokes": [ # Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. + "A String", + ], "uri": "A String", # Required. The URI of the VPC network resource. }, "linkedVpnTunnels": { # A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. # VPN tunnels that are associated with the spoke. diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html index da8ff70b2d7..6b28b8e8f0a 100644 --- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html +++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html @@ -126,6 +126,10 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, + "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet} + "target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet} + }, "name": "A String", # Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names "network": "A String", # The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network} "overlaps": [ # Optional. Types of resources that are allowed to overlap with the current internal range. @@ -231,6 +235,10 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, + "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet} + "target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet} + }, "name": "A String", # Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names "network": "A String", # The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network} "overlaps": [ # Optional. Types of resources that are allowed to overlap with the current internal range. @@ -324,6 +332,10 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, + "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet} + "target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet} + }, "name": "A String", # Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names "network": "A String", # The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network} "overlaps": [ # Optional. Types of resources that are allowed to overlap with the current internal range. @@ -378,6 +390,10 @@

Method Details

"labels": { # User-defined labels. "a_key": "A String", }, + "migration": { # Specification for migration with source and target resource names. # Optional. Should be present if usage is set to FOR_MIGRATION. + "source": "A String", # Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet} + "target": "A String", # Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet} + }, "name": "A String", # Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names "network": "A String", # The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network} "overlaps": [ # Optional. Types of resources that are allowed to overlap with the current internal range. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.html index 6aa235bf033..7c6e21ff698 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the global_ Resource.

+

+ vpcFlowLogsConfigs() +

+

Returns the vpcFlowLogsConfigs Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html index 93e3b16bc46..a92c9e72dd6 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.vpcFlowLogsConfigs.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new VPC Flow Logs configuration. If a configuration with the exact same settings already exists, the creation fails.

+

Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

delete(name, x__xgafv=None)

-

Deletes a specific VpcFlowLog configuration.

+

Deletes a specific `VpcFlowLogsConfig`.

get(name, x__xgafv=None)

-

Gets the details of a specific VPC Flow Log configuration.

+

Gets the details of a specific `VpcFlowLogsConfig`.

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

-

Lists all VPC Flow Logs configurations in a given project.

+

Lists all `VpcFlowLogsConfigs` in a given project.

list_next()

Retrieves the next page of results.

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

-

Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists, the creation fails.

+

Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description

Method Details

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

Method Details

create(parent, body=None, vpcFlowLogsConfigId=None, x__xgafv=None) -
Creates a new VPC Flow Logs configuration. If a configuration with the exact same settings already exists, the creation fails.
+  
Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description
 
 Args:
   parent: string, Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id}/locations/global` (required)
@@ -114,9 +114,9 @@ 

Method Details

"aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. "createTime": "A String", # Output only. The time the config was created. "description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. - "filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged. - "flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0. - "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name} + "filterExpr": "A String", # Optional. Export filter used to define which VPC Flow Logs should be logged. + "flowSampling": 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name} "labels": { # Optional. Resource labels to represent user-provided metadata. "a_key": "A String", }, @@ -124,15 +124,13 @@

Method Details

"metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. "A String", ], - "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}` - "network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name} - "state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED. - "subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name} + "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` + "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. "updateTime": "A String", # Output only. The time the config was updated. - "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name} + "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} } - vpcFlowLogsConfigId: string, Required. ID of the VpcFlowLogsConfig. + vpcFlowLogsConfigId: string, Required. ID of the `VpcFlowLogsConfig`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -164,10 +162,10 @@

Method Details

delete(name, x__xgafv=None) -
Deletes a specific VpcFlowLog configuration.
+  
Deletes a specific `VpcFlowLogsConfig`.
 
 Args:
-  name: string, Required. VpcFlowLogsConfig name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` (required)
+  name: string, Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -199,10 +197,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets the details of a specific VPC Flow Log configuration.
+  
Gets the details of a specific `VpcFlowLogsConfig`.
 
 Args:
-  name: string, Required. `VpcFlowLog` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` (required)
+  name: string, Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,9 +213,9 @@ 

Method Details

"aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. "createTime": "A String", # Output only. The time the config was created. "description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. - "filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged. - "flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0. - "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name} + "filterExpr": "A String", # Optional. Export filter used to define which VPC Flow Logs should be logged. + "flowSampling": 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name} "labels": { # Optional. Resource labels to represent user-provided metadata. "a_key": "A String", }, @@ -225,24 +223,22 @@

Method Details

"metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. "A String", ], - "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}` - "network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name} - "state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED. - "subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name} + "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` + "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. "updateTime": "A String", # Output only. The time the config was updated. - "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name} + "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} }
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all VPC Flow Logs configurations in a given project.
+  
Lists all `VpcFlowLogsConfigs` in a given project.
 
 Args:
   parent: string, Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global` (required)
-  filter: string, Optional. Lists the `VpcFlowLogsConfig`s that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = "projects/proj-1/locations/global/vpcFlowLogsConfigs/config-1 - Filter by target resource: - Configurations at the VPC network level target_resource.network:* - Configurations for a VPC network called `vpc-1` target_resource.network = vpc-1
+  filter: string, Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).
   orderBy: string, Optional. Field to use to sort the list.
-  pageSize: integer, Optional. Number of `VpcFlowLogsConfig`s to return.
+  pageSize: integer, Optional. Number of `VpcFlowLogsConfigs` to return.
   pageToken: string, Optional. Page token from an earlier query, as returned in `next_page_token`.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -262,9 +258,9 @@ 

Method Details

"aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. "createTime": "A String", # Output only. The time the config was created. "description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. - "filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged. - "flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0. - "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name} + "filterExpr": "A String", # Optional. Export filter used to define which VPC Flow Logs should be logged. + "flowSampling": 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name} "labels": { # Optional. Resource labels to represent user-provided metadata. "a_key": "A String", }, @@ -272,12 +268,10 @@

Method Details

"metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. "A String", ], - "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}` - "network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name} - "state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED. - "subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name} + "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` + "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. "updateTime": "A String", # Output only. The time the config was updated. - "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name} + "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} }, ], }
@@ -299,10 +293,10 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an existing VpcFlowLogsConfig. If a configuration with the exact same settings already exists, the creation fails.
+  
Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description
 
 Args:
-  name: string, Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}` (required)
+  name: string, Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -310,9 +304,9 @@ 

Method Details

"aggregationInterval": "A String", # Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. "createTime": "A String", # Output only. The time the config was created. "description": "A String", # Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. - "filterExpr": "A String", # Export filter used to define which VPC flow logs should be logged. - "flowSampling": 3.14, # Optional. The value of the field must be in [0, 1]. The sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default value is 1.0. - "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/locations/{region}/interconnectAttachments/{name} + "filterExpr": "A String", # Optional. Export filter used to define which VPC Flow Logs should be logged. + "flowSampling": 3.14, # Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + "interconnectAttachment": "A String", # Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name} "labels": { # Optional. Resource labels to represent user-provided metadata. "a_key": "A String", }, @@ -320,12 +314,10 @@

Method Details

"metadataFields": [ # Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. "A String", ], - "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogs/{vpc_flow_log}` - "network": "A String", # Traffic will be logged from VMs, VPN tunnels and Interconnect Attachments within the network. Format: projects/{project_id}/networks/{name} - "state": "A String", # Optional. The state of the VPC Flow Log. Default value is ENABLED. - "subnet": "A String", # Traffic will be logged from VMs within the subnetwork. Format: projects/{project_id}/locations/{region}/subnetworks/{name} + "name": "A String", # Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}` + "state": "A String", # Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. "updateTime": "A String", # Output only. The time the config was updated. - "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/locations/{region}/vpnTunnels/{name} + "vpnTunnel": "A String", # Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name} } updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. diff --git a/docs/dyn/playintegrity_v1.deviceRecall.html b/docs/dyn/playintegrity_v1.deviceRecall.html index 7de25202f97..80143e11011 100644 --- a/docs/dyn/playintegrity_v1.deviceRecall.html +++ b/docs/dyn/playintegrity_v1.deviceRecall.html @@ -96,7 +96,7 @@

Method Details

The object takes the form of: { # Request to write device recall bits. - "integrityToken": "A String", # Required. Integrity token obtained from calling Play Integrity API. Note that the integrity token contains the existing device recall bits. The write will only succeed if those bits in the integrity token are up to date. + "integrityToken": "A String", # Required. Integrity token obtained from calling Play Integrity API. "newValues": { # Contains the recall bits values. # Required. The new values for the device recall bits to be written. "bitFirst": True or False, # Required. First recall bit value. "bitSecond": True or False, # Required. Second recall bit value. diff --git a/docs/dyn/playintegrity_v1.v1.html b/docs/dyn/playintegrity_v1.v1.html index f8d65ce435d..394267a5097 100644 --- a/docs/dyn/playintegrity_v1.v1.html +++ b/docs/dyn/playintegrity_v1.v1.html @@ -123,8 +123,8 @@

Method Details

"packageName": "A String", # Package name of the application under attestation. Set iff app_recognition_verdict != UNEVALUATED. "versionCode": "A String", # Version code of the application. Set iff app_recognition_verdict != UNEVALUATED. }, - "deviceIntegrity": { # Contains the device attestation information. Next tag: 4 # Required. Details about the device integrity. - "deviceRecall": { # Contains the recall bits per device set by the developer. Next tag: 3 # Details about the device recall bits set by the developer. + "deviceIntegrity": { # Contains the device attestation information. # Required. Details about the device integrity. + "deviceRecall": { # Contains the recall bits per device set by the developer. # Details about the device recall bits set by the developer. "values": { # Contains the recall bits values. # Required. Contains the recall bits values. "bitFirst": True or False, # Required. First recall bit value. "bitSecond": True or False, # Required. Second recall bit value. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index c4f2e7d3df9..f6e608a3acc 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -95,6 +95,12 @@

Instance Methods

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

Returns the list of all keys that belong to a project.

+

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

+

Lists all IP overrides for a key.

+

+ listIpOverrides_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

@@ -104,6 +110,9 @@

Instance Methods

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

Updates the specified key.

+

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

+

Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error will be returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error will be returned.

retrieveLegacySecretKey(x__xgafv=None)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

@@ -434,6 +443,47 @@

Method Details

}
+
+ listIpOverrides(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all IP overrides for a key.
+
+Args:
+  parent: string, Required. The parent key for which the IP overrides are listed, in the format `projects/{project}/keys/{key}`. (required)
+  pageSize: integer, Optional. The maximum number of overrides to return. Default is 10. Max limit is 100. If the number of overrides is less than the page_size, all overrides are returned. If the page size is more than 100, it is coerced to 100.
+  pageToken: string, Optional. The next_page_token value returned from a previous ListIpOverridesRequest, if any.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListIpOverrides.
+  "ipOverrides": [ # IP Overrides details.
+    { # Information about the IP or IP range override.
+      "ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
+      "overrideType": "A String", # Required. Describes the type of IP override.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results. If this field is empty, no keys remain in the results.
+}
+
+ +
+ listIpOverrides_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.
+        
+
+
list_next()
Retrieves the next page of results.
@@ -621,6 +671,34 @@ 

Method Details

}
+
+ removeIpOverride(name, body=None, x__xgafv=None) +
Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error will be returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error will be returned.
+
+Args:
+  name: string, Required. The name of the key from which the IP override is removed, in the format `projects/{project}/keys/{key}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The removeIpOverride request message.
+  "ipOverrideData": { # Information about the IP or IP range override. # Required. IP override to be removed from the key.
+    "ip": "A String", # Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48
+    "overrideType": "A String", # Required. Describes the type of IP override.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for RemoveIpOverride.
+}
+
+
retrieveLegacySecretKey(x__xgafv=None)
Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.
diff --git a/docs/dyn/redis_v1.projects.locations.clusters.html b/docs/dyn/redis_v1.projects.locations.clusters.html
index 8c9bfec7f19..6852970e8cd 100644
--- a/docs/dyn/redis_v1.projects.locations.clusters.html
+++ b/docs/dyn/redis_v1.projects.locations.clusters.html
@@ -116,6 +116,32 @@ 

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -157,7 +183,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. @@ -258,6 +284,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -299,7 +351,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. @@ -366,6 +418,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -407,7 +485,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. @@ -457,6 +535,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -498,7 +602,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. diff --git a/docs/dyn/redis_v1beta1.projects.locations.clusters.html b/docs/dyn/redis_v1beta1.projects.locations.clusters.html index a7af2f44068..679c359eaa0 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/redis_v1beta1.projects.locations.clusters.html @@ -116,6 +116,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -157,7 +183,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. @@ -258,6 +284,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -299,7 +351,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. @@ -366,6 +418,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -407,7 +485,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. @@ -457,6 +535,32 @@

Method Details

{ # A cluster instance. "authorizationMode": "A String", # Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. "createTime": "A String", # Output only. The timestamp associated with the cluster creation request. + "crossClusterReplicationConfig": { # Cross cluster replication config. # Optional. Cross cluster replication config. + "clusterRole": "A String", # The role of the cluster in cross cluster replication. + "membership": { # An output only view of all the member clusters participating in the cross cluster replication. # Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Output only. The primary cluster that acts as the source of replication for the secondary clusters. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # Output only. The list of secondary clusters replicating from the primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + }, + "primaryCluster": { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. # Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + "secondaryClusters": [ # List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + { # Details of the remote cluster associated with this cluster in a cross cluster replication setup. + "cluster": "A String", # The full resource path of the remote cluster in the format: projects//locations//clusters/ + "uid": "A String", # Output only. The unique identifier of the remote cluster. + }, + ], + "updateTime": "A String", # Output only. The last time cross cluster replication config was updated. + }, "deletionProtectionEnabled": True or False, # Optional. The delete operation will fail when the value is set to true. "discoveryEndpoints": [ # Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. { # Endpoints on each network, for Redis clients to connect to the cluster. @@ -498,7 +602,7 @@

Method Details

"a_key": "A String", }, "replicaCount": 42, # Optional. The number of replica nodes per shard. - "shardCount": 42, # Required. Number of shards for the Redis cluster. + "shardCount": 42, # Optional. Number of shards for the Redis cluster. "sizeGb": 42, # Output only. Redis memory size in GB for the entire cluster rounded up to the next integer. "state": "A String", # Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED "stateInfo": { # Represents additional information about the state of the cluster. # Output only. Additional information about the current state of the cluster. diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html index 416a7207dda..602c4bf2e93 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -257,7 +257,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -385,7 +385,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -500,7 +500,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -622,7 +622,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -726,7 +726,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html index da6fea28afc..039eb9b1325 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html @@ -184,7 +184,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -319,7 +319,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -478,7 +478,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -624,7 +624,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -777,7 +777,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -912,7 +912,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html index 37cce960854..d75256881d9 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html @@ -184,7 +184,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -319,7 +319,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -478,7 +478,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -624,7 +624,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -777,7 +777,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. @@ -912,7 +912,7 @@

Method Details

"filter": "A String", # A filter to apply on the matching condition results. Supported features: * filter must be set. * Filter syntax is identical to SearchRequest.filter. For more information, see [Filter](/retail/docs/filter-and-order#filter). * To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": *(id: ANY("product_1", "product_2")) * *AND * *(colorFamilies: ANY("Red", "Blue")) * }, "forceReturnFacetAction": { # Force returns an attribute/facet in the request around a certain position or above. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. * Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank. # Force returns an attribute as a facet in the request. - "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here. + "facetPositionAdjustments": [ # Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here. { # Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position. "attributeName": "A String", # The attribute name to force return as a facet. Each attribute name should be a valid attribute name, be non-empty and contain at most 80 characters long. "position": 42, # This is the position in the request as explained above. It should be strictly positive be at most 100. diff --git a/docs/dyn/run_v2.projects.locations.builds.html b/docs/dyn/run_v2.projects.locations.builds.html new file mode 100644 index 00000000000..75d6033331d --- /dev/null +++ b/docs/dyn/run_v2.projects.locations.builds.html @@ -0,0 +1,156 @@ + + + +

Cloud Run Admin API . projects . locations . builds

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Submits a build in a given project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ submit(parent, body=None, x__xgafv=None) +
Submits a build in a given project.
+
+Args:
+  parent: string, Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: projects/{project}/locations/{location} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for submitting a Build.
+  "buildpackBuild": { # Build the source using Buildpacks. # Build the source using Buildpacks.
+    "baseImage": "A String", # Optional. The base image used to opt into automatic base image updates.
+    "cacheImageUri": "A String", # Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.
+    "enableAutomaticUpdates": True or False, # Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.
+    "environmentVariables": { # Optional. User-provided build-time environment variables.
+      "a_key": "A String",
+    },
+    "functionTarget": "A String", # Optional. Name of the function target if the source is a function source. Required for function builds.
+    "runtime": "A String", # The runtime name, e.g. 'go113'. Leave blank for generic builds.
+  },
+  "dockerBuild": { # Build the source using Docker. This means the source has a Dockerfile. # Build the source using Docker. This means the source has a Dockerfile.
+  },
+  "imageUri": "A String", # Required. Artifact Registry URI to store the built image.
+  "serviceAccount": "A String", # Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.
+  "storageSource": { # Location of the source in an archive file in Google Cloud Storage. # Required. Source for the build.
+    "bucket": "A String", # Required. Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
+    "generation": "A String", # Optional. Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
+    "object": "A String", # Required. Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
+  },
+  "tags": [ # Optional. Additional tags to annotate the build.
+    "A String",
+  ],
+  "workerPool": "A String", # Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.
+}
+
+  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 submitting a Build.
+  "baseImageUri": "A String", # URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.
+  "buildOperation": { # This resource represents a long-running operation that is the result of a network API call. # Cloud Build operation to be polled via CloudBuild API.
+    "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/run_v2.projects.locations.html b/docs/dyn/run_v2.projects.locations.html index 4725a12beeb..f1c3cbb78cd 100644 --- a/docs/dyn/run_v2.projects.locations.html +++ b/docs/dyn/run_v2.projects.locations.html @@ -74,6 +74,11 @@

Cloud Run Admin API . projects . locations

Instance Methods

+

+ builds() +

+

Returns the builds Resource.

+

jobs()

diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html index 05f4fda2878..7f8c72711b5 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html @@ -291,7 +291,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -502,7 +502,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index d1249c79268..00fa9cd403f 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -137,7 +137,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -355,7 +355,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index 08a9320f2f2..31141238751 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -199,7 +199,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -500,7 +500,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -787,7 +787,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -1033,7 +1033,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -1232,7 +1232,7 @@

Method Details

"env": [ # List of environment variables to set in the container. Will be merged with existing env for override. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 5b31c6f4857..4a220b5b718 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -191,7 +191,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -520,7 +520,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -836,7 +836,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -1109,7 +1109,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 2359ef9ac3b..2ceb82ddf1a 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -215,7 +215,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. @@ -432,7 +432,7 @@

Method Details

"env": [ # List of environment variables to set in the container. { # EnvVar represents an environment variable present in a Container. "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. - "value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to "", and the maximum length is 32768 bytes. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. diff --git a/docs/dyn/searchads360_v0.customers.searchAds360.html b/docs/dyn/searchads360_v0.customers.searchAds360.html index 8111319b79c..46448437b8c 100644 --- a/docs/dyn/searchads360_v0.customers.searchAds360.html +++ b/docs/dyn/searchads360_v0.customers.searchAds360.html @@ -236,6 +236,16 @@

Method Details

"resourceName": "A String", # Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}` "responsiveSearchAd": { # A Search Ads 360 responsive search ad. # Immutable. Details pertaining to a responsive search ad. "adTrackingId": "A String", # The tracking id of the ad. + "descriptions": [ # List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. + { # A text asset used inside an ad. + "text": "A String", # Asset text. + }, + ], + "headlines": [ # List of text assets for headlines. When the ad serves the headlines will be selected from this list. + { # A text asset used inside an ad. + "text": "A String", # Asset text. + }, + ], "path1": "A String", # Text appended to the auto-generated visible URL with a delimiter. "path2": "A String", # Text appended to path1 with a delimiter. }, @@ -250,7 +260,7 @@

Method Details

"type": "A String", # Output only. The type of ad. }, "creationTime": "A String", # Output only. The timestamp when this ad_group_ad was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. - "engineId": "A String", # Output only. ID of the ad in the external engine account. This field is for SearchAds 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-SearchAds 360 entity, use "ad_group_ad.ad.id" instead. + "engineId": "A String", # Output only. ID of the ad in the external engine account. This field is for Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 360 entity, use "ad_group_ad.ad.id" instead. "engineStatus": "A String", # Output only. Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active, eligible, pending review, etc. "labels": [ # Output only. The resource names of labels attached to this ad group ad. "A String", @@ -632,7 +642,7 @@

Method Details

}, "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # A bid strategy that sets your bids to help get as many clicks as possible within your budget. "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. - "targetSpendMicros": "A String", # The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. + "targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. }, "type": "A String", # Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only. }, @@ -743,7 +753,7 @@

Method Details

}, "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget. "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. - "targetSpendMicros": "A String", # The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. + "targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. }, "trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information. "trackingUrl": "A String", # Output only. The url used for dynamic tracking. @@ -855,7 +865,7 @@

Method Details

"floodlightOrderId": "A String", # Output only. The Floodlight order ID provided by the advertiser for the conversion. "floodlightOriginalRevenue": "A String", # Output only. The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications. "id": "A String", # Output only. The ID of the conversion - "merchantId": "A String", # Output only. The SearchAds360 inventory account ID containing the product that was clicked on. SearchAds360 generates this ID when you link an inventory account in SearchAds360. + "merchantId": "A String", # Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360. "productChannel": "A String", # Output only. The sales channel of the product that was clicked on: Online or Local. "productCountryCode": "A String", # Output only. The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on. "productId": "A String", # Output only. The ID of the product clicked on. @@ -863,7 +873,7 @@

Method Details

"productStoreId": "A String", # Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed. "resourceName": "A String", # Output only. The resource name of the conversion. Conversion resource names have the form: `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}` "status": "A String", # Output only. The status of the conversion, either ENABLED or REMOVED.. - "visitId": "A String", # Output only. The SearchAds360 visit ID that the conversion is attributed to. + "visitId": "A String", # Output only. The Search Ads 360 visit ID that the conversion is attributed to. }, "conversionAction": { # A conversion action. # The conversion action referenced in the query. "appId": "A String", # App ID for an app conversion action. @@ -982,6 +992,7 @@

Method Details

"managerCustomer": "A String", # Output only. The manager customer linked to the customer. "managerLinkId": "A String", # Output only. ID of the customer-manager link. This field is read only. "resourceName": "A String", # Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}` + "startTime": "A String", # Output only. The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. "status": "A String", # Status of the link between the customer and the manager. }, "dynamicSearchAdsSearchTermView": { # A dynamic search ads search term view. # The dynamic search ads search term view referenced in the query. @@ -1010,7 +1021,7 @@

Method Details

"resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}` "status": "A String", # Output only. Status of the label. Read only. "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background. - "backgroundColor": "A String", # Background color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts. + "backgroundColor": "A String", # Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts. "description": "A String", # A short description of the label. The length must be no more than 200 characters. }, }, @@ -1043,6 +1054,7 @@

Method Details

"averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "averageQualityScore": 3.14, # The average quality score. "clicks": "A String", # The number of clicks. "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. @@ -1163,6 +1175,11 @@

Method Details

"date": "A String", # Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17. "dayOfWeek": "A String", # Day of the week, for example, MONDAY. "device": "A String", # Device to which metrics apply. + "geoTargetCity": "A String", # Resource name of the geo target constant that represents a city. + "geoTargetCountry": "A String", # Resource name of the geo target constant that represents a country. + "geoTargetMetro": "A String", # Resource name of the geo target constant that represents a metro. + "geoTargetRegion": "A String", # Resource name of the geo target constant that represents a region. + "hour": 42, # Hour of day as a number between 0 and 23, inclusive. "keyword": { # A Keyword criterion segment. # Keyword criterion. "adGroupCriterion": "A String", # The AdGroupCriterion resource name. "info": { # A keyword criterion. # Keyword info. @@ -1343,6 +1360,16 @@

Method Details

"resourceName": "A String", # Immutable. The resource name of the ad. Ad resource names have the form: `customers/{customer_id}/ads/{ad_id}` "responsiveSearchAd": { # A Search Ads 360 responsive search ad. # Immutable. Details pertaining to a responsive search ad. "adTrackingId": "A String", # The tracking id of the ad. + "descriptions": [ # List of text assets for descriptions. When the ad serves the descriptions will be selected from this list. + { # A text asset used inside an ad. + "text": "A String", # Asset text. + }, + ], + "headlines": [ # List of text assets for headlines. When the ad serves the headlines will be selected from this list. + { # A text asset used inside an ad. + "text": "A String", # Asset text. + }, + ], "path1": "A String", # Text appended to the auto-generated visible URL with a delimiter. "path2": "A String", # Text appended to path1 with a delimiter. }, @@ -1357,7 +1384,7 @@

Method Details

"type": "A String", # Output only. The type of ad. }, "creationTime": "A String", # Output only. The timestamp when this ad_group_ad was created. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. - "engineId": "A String", # Output only. ID of the ad in the external engine account. This field is for SearchAds 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-SearchAds 360 entity, use "ad_group_ad.ad.id" instead. + "engineId": "A String", # Output only. ID of the ad in the external engine account. This field is for Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 360 entity, use "ad_group_ad.ad.id" instead. "engineStatus": "A String", # Output only. Additional status of the ad in the external engine account. Possible statuses (depending on the type of external account) include active, eligible, pending review, etc. "labels": [ # Output only. The resource names of labels attached to this ad group ad. "A String", @@ -1739,7 +1766,7 @@

Method Details

}, "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # A bid strategy that sets your bids to help get as many clicks as possible within your budget. "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. - "targetSpendMicros": "A String", # The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. + "targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. }, "type": "A String", # Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only. }, @@ -1850,7 +1877,7 @@

Method Details

}, "targetSpend": { # An automated bid strategy that sets your bids to help get as many clicks as possible within your budget. # Standard Target Spend bidding strategy that automatically sets your bids to help get as many clicks as possible within your budget. "cpcBidCeilingMicros": "A String", # Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy. - "targetSpendMicros": "A String", # The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. + "targetSpendMicros": "A String", # Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details. }, "trackingSetting": { # Campaign-level settings for tracking information. # Output only. Campaign-level settings for tracking information. "trackingUrl": "A String", # Output only. The url used for dynamic tracking. @@ -1962,7 +1989,7 @@

Method Details

"floodlightOrderId": "A String", # Output only. The Floodlight order ID provided by the advertiser for the conversion. "floodlightOriginalRevenue": "A String", # Output only. The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications. "id": "A String", # Output only. The ID of the conversion - "merchantId": "A String", # Output only. The SearchAds360 inventory account ID containing the product that was clicked on. SearchAds360 generates this ID when you link an inventory account in SearchAds360. + "merchantId": "A String", # Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360. "productChannel": "A String", # Output only. The sales channel of the product that was clicked on: Online or Local. "productCountryCode": "A String", # Output only. The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on. "productId": "A String", # Output only. The ID of the product clicked on. @@ -1970,7 +1997,7 @@

Method Details

"productStoreId": "A String", # Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed. "resourceName": "A String", # Output only. The resource name of the conversion. Conversion resource names have the form: `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}` "status": "A String", # Output only. The status of the conversion, either ENABLED or REMOVED.. - "visitId": "A String", # Output only. The SearchAds360 visit ID that the conversion is attributed to. + "visitId": "A String", # Output only. The Search Ads 360 visit ID that the conversion is attributed to. }, "conversionAction": { # A conversion action. # The conversion action referenced in the query. "appId": "A String", # App ID for an app conversion action. @@ -2089,6 +2116,7 @@

Method Details

"managerCustomer": "A String", # Output only. The manager customer linked to the customer. "managerLinkId": "A String", # Output only. ID of the customer-manager link. This field is read only. "resourceName": "A String", # Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}` + "startTime": "A String", # Output only. The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. "status": "A String", # Status of the link between the customer and the manager. }, "dynamicSearchAdsSearchTermView": { # A dynamic search ads search term view. # The dynamic search ads search term view referenced in the query. @@ -2117,7 +2145,7 @@

Method Details

"resourceName": "A String", # Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}` "status": "A String", # Output only. Status of the label. Read only. "textLabel": { # A type of label displaying text on a colored background. # A type of label displaying text on a colored background. - "backgroundColor": "A String", # Background color of the label in RGB format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts. + "backgroundColor": "A String", # Background color of the label in HEX format. This string must match the regular expression '^\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts. "description": "A String", # A short description of the label. The length must be no more than 200 characters. }, }, @@ -2150,6 +2178,7 @@

Method Details

"averageCost": 3.14, # The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions. "averageCpc": 3.14, # The total cost of all clicks divided by the total number of clicks received. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause "averageCpm": 3.14, # Average cost-per-thousand impressions (CPM). This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + "averageQualityScore": 3.14, # The average quality score. "clicks": "A String", # The number of clicks. "clientAccountConversions": 3.14, # The number of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. "clientAccountConversionsValue": 3.14, # The value of client account conversions. This only includes conversion actions which include_in_client_account_conversions_metric attribute is set to true. If you use conversion-based bidding, your bid strategies will optimize for these conversions. @@ -2270,6 +2299,11 @@

Method Details

"date": "A String", # Date to which metrics apply. yyyy-MM-dd format, for example, 2018-04-17. "dayOfWeek": "A String", # Day of the week, for example, MONDAY. "device": "A String", # Device to which metrics apply. + "geoTargetCity": "A String", # Resource name of the geo target constant that represents a city. + "geoTargetCountry": "A String", # Resource name of the geo target constant that represents a country. + "geoTargetMetro": "A String", # Resource name of the geo target constant that represents a metro. + "geoTargetRegion": "A String", # Resource name of the geo target constant that represents a region. + "hour": 42, # Hour of day as a number between 0 and 23, inclusive. "keyword": { # A Keyword criterion segment. # Keyword criterion. "adGroupCriterion": "A String", # The AdGroupCriterion resource name. "info": { # A keyword criterion. # Keyword info. diff --git a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html index 5c1d002828c..e23b146ef84 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html @@ -108,7 +108,7 @@

Method Details

{ # The response for ListInstanceConfigOperations. "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListInstanceConfigOperations call to fetch more of the matching metadata. - "operations": [ # The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. + "operations": [ # The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the name of the instance configuration. The operation's metadata field type `metadata.type_url` describes the type of the metadata. { # 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. diff --git a/docs/dyn/spanner_v1.projects.instanceConfigs.html b/docs/dyn/spanner_v1.projects.instanceConfigs.html index e6d69508237..bfda814c9d2 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigs.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigs.html @@ -89,10 +89,10 @@

Instance Methods

Close httplib2 connections.

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

-

Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

+

Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

delete(name, etag=None, validateOnly=None, x__xgafv=None)

-

Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.

+

Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.

get(name, x__xgafv=None)

Gets information about a particular instance configuration.

@@ -104,7 +104,7 @@

Instance Methods

Retrieves the next page of results.

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

-

Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

+

Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

Method Details

close() @@ -113,20 +113,20 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
+  
Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
 
 Args:
-  parent: string, Required. The name of the project in which to create the instance config. Values are of the form `projects/`. (required)
+  parent: string, Required. The name of the project in which to create the instance configuration. Values are of the form `projects/`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # The request for CreateInstanceConfigRequest.
-  "instanceConfig": { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. # Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3.
+  "instanceConfig": { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. # Required. The `InstanceConfig` proto of the configuration to create. `instance_config.name` must be `/instanceConfigs/`. `instance_config.base_config` must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3.
     "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration.
-    "configType": "A String", # Output only. Whether this instance configuration is a Google- or user-managed configuration.
+    "configType": "A String", # Output only. Whether this instance configuration is a Google-managed or user-managed configuration.
     "displayName": "A String", # The name of this instance configuration as it appears in UIs.
     "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.
-    "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config.
+    "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance configuration.
     "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release.
       "a_key": "A String",
     },
@@ -142,7 +142,7 @@ 

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config. + "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration. "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. { "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. @@ -188,11 +188,11 @@

Method Details

delete(name, etag=None, validateOnly=None, x__xgafv=None) -
Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.
+  
Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.
 
 Args:
   name: string, Required. The name of the instance configuration to be deleted. Values are of the form `projects//instanceConfigs/` (required)
-  etag: string, Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance configuration without checking the current status of the requested instance config.
+  etag: string, Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration.
   validateOnly: boolean, An option to validate, but not actually execute, a request, and provide the same response.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -222,10 +222,10 @@ 

Method Details

{ # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration. - "configType": "A String", # Output only. Whether this instance configuration is a Google- or user-managed configuration. + "configType": "A String", # Output only. Whether this instance configuration is a Google-managed or user-managed configuration. "displayName": "A String", # The name of this instance configuration as it appears in UIs. "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly. - "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. + "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance configuration. "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. "a_key": "A String", }, @@ -241,7 +241,7 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config. + "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration. "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. { "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. @@ -274,10 +274,10 @@

Method Details

"instanceConfigs": [ # The list of requested instance configurations. { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration. - "configType": "A String", # Output only. Whether this instance configuration is a Google- or user-managed configuration. + "configType": "A String", # Output only. Whether this instance configuration is a Google-managed or user-managed configuration. "displayName": "A String", # The name of this instance configuration as it appears in UIs. "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly. - "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. + "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance configuration. "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. "a_key": "A String", }, @@ -293,7 +293,7 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config. + "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration. "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. { "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. @@ -325,7 +325,7 @@

Method Details

patch(name, body=None, x__xgafv=None) -
Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
+  
Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
 
 Args:
   name: string, A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. (required)
@@ -335,10 +335,10 @@ 

Method Details

{ # The request for UpdateInstanceConfigRequest. "instanceConfig": { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. # Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. "baseConfig": "A String", # Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration. - "configType": "A String", # Output only. Whether this instance configuration is a Google- or user-managed configuration. + "configType": "A String", # Output only. Whether this instance configuration is a Google-managed or user-managed configuration. "displayName": "A String", # The name of this instance configuration as it appears in UIs. "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly. - "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. + "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance configuration. "labels": { # Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. "a_key": "A String", }, @@ -354,7 +354,7 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config. + "reconciling": True or False, # Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration. "replicas": [ # The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. { "defaultLeaderLocation": True or False, # If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details. diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index c1fcaf72b53..327fd75e69c 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -213,16 +213,20 @@

Method Details

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup. }, ], + "exclusiveSizeBytes": "A String", # Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. + "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. + "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. + "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. "referencingBackups": [ # Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. "A String", ], "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. "A String", ], - "sizeBytes": "A String", # Output only. Size of the backup in bytes. + "sizeBytes": "A String", # Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. "state": "A String", # Output only. The current state of the backup. "versionTime": "A String", # The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. } @@ -332,16 +336,20 @@

Method Details

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup. }, ], + "exclusiveSizeBytes": "A String", # Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. + "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. + "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. + "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. "referencingBackups": [ # Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. "A String", ], "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. "A String", ], - "sizeBytes": "A String", # Output only. Size of the backup in bytes. + "sizeBytes": "A String", # Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. "state": "A String", # Output only. The current state of the backup. "versionTime": "A String", # The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. }
@@ -444,16 +452,20 @@

Method Details

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup. }, ], + "exclusiveSizeBytes": "A String", # Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. + "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. + "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. + "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. "referencingBackups": [ # Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. "A String", ], "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. "A String", ], - "sizeBytes": "A String", # Output only. Size of the backup in bytes. + "sizeBytes": "A String", # Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. "state": "A String", # Output only. The current state of the backup. "versionTime": "A String", # The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. }, @@ -520,16 +532,20 @@

Method Details

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup. }, ], + "exclusiveSizeBytes": "A String", # Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. + "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. + "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. + "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. "referencingBackups": [ # Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. "A String", ], "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. "A String", ], - "sizeBytes": "A String", # Output only. Size of the backup in bytes. + "sizeBytes": "A String", # Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. "state": "A String", # Output only. The current state of the backup. "versionTime": "A String", # The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. } @@ -578,16 +594,20 @@

Method Details

"kmsKeyVersion": "A String", # Output only. A Cloud KMS key version that is being used to protect the database or backup. }, ], + "exclusiveSizeBytes": "A String", # Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. "expireTime": "A String", # Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. + "freeableSizeBytes": "A String", # Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. + "incrementalBackupChainId": "A String", # Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. "maxExpireTime": "A String", # Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. "name": "A String", # Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. + "oldestVersionTime": "A String", # Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. "referencingBackups": [ # Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. "A String", ], "referencingDatabases": [ # Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. "A String", ], - "sizeBytes": "A String", # Output only. Size of the backup in bytes. + "sizeBytes": "A String", # Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. "state": "A String", # Output only. The current state of the backup. "versionTime": "A String", # The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. }
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html index dca1fc93521..588a5ac240b 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html @@ -129,6 +129,8 @@

Method Details

}, "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups. }, + "incrementalBackupSpec": { # The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. # The schedule creates incremental backup chains. + }, "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. @@ -160,6 +162,8 @@

Method Details

}, "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups. }, + "incrementalBackupSpec": { # The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. # The schedule creates incremental backup chains. + }, "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. @@ -215,6 +219,8 @@

Method Details

}, "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups. }, + "incrementalBackupSpec": { # The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. # The schedule creates incremental backup chains. + }, "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. @@ -299,6 +305,8 @@

Method Details

}, "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups. }, + "incrementalBackupSpec": { # The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. # The schedule creates incremental backup chains. + }, "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. @@ -348,6 +356,8 @@

Method Details

}, "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups. }, + "incrementalBackupSpec": { # The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. # The schedule creates incremental backup chains. + }, "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. @@ -379,6 +389,8 @@

Method Details

}, "fullBackupSpec": { # The specification for full backups. A full backup stores the entire contents of the database at a given version time. # The schedule creates only full backups. }, + "incrementalBackupSpec": { # The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. # The schedule creates incremental backup chains. + }, "name": "A String", # Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. "retentionDuration": "A String", # Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. "spec": { # Defines specifications of the backup schedule. # Optional. The schedule specification based on which the backup creations are triggered. diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index baf6f2c1def..988253613bf 100644 --- a/docs/dyn/spanner_v1.projects.instances.html +++ b/docs/dyn/spanner_v1.projects.instances.html @@ -132,7 +132,7 @@

Instance Methods

Retrieves the next page of results.

move(name, body=None, x__xgafv=None)

-

Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).

+

Moves an instance to the target instance configuration. You can use the returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup` * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. If not cancelled, upon completion of the returned operation: * The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration. Authorization requires the `spanner.instances.update` permission on the resource instance. For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance).

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

Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on the resource name.

@@ -174,6 +174,7 @@

Method Details

"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. "createTime": "A String", # Output only. The time at which the instance was created. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. + "edition": "A String", # Optional. The `Edition` of the current instance. "endpointUris": [ # Deprecated. This field is not populated. "A String", ], @@ -187,8 +188,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }, @@ -273,6 +274,7 @@

Method Details

"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. "createTime": "A String", # Output only. The time at which the instance was created. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. + "edition": "A String", # Optional. The `Edition` of the current instance. "endpointUris": [ # Deprecated. This field is not populated. "A String", ], @@ -286,8 +288,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }
@@ -372,6 +374,7 @@

Method Details

"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. "createTime": "A String", # Output only. The time at which the instance was created. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. + "edition": "A String", # Optional. The `Edition` of the current instance. "endpointUris": [ # Deprecated. This field is not populated. "A String", ], @@ -385,8 +388,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }, @@ -414,7 +417,7 @@

Method Details

move(name, body=None, x__xgafv=None) -
Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).
+  
Moves an instance to the target instance configuration. You can use the returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup` * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. If not cancelled, upon completion of the returned operation: * The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration. Authorization requires the `spanner.instances.update` permission on the resource instance. For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance).
 
 Args:
   name: string, Required. The instance to move. Values are of the form `projects//instances/`. (required)
@@ -422,7 +425,7 @@ 

Method Details

The object takes the form of: { # The request for MoveInstance. - "targetConfig": "A String", # Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`. + "targetConfig": "A String", # Required. The target instance configuration where to move the instance. Values are of the form `projects//instanceConfigs/`. } x__xgafv: string, V1 error format. @@ -481,6 +484,7 @@

Method Details

"config": "A String", # Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. "createTime": "A String", # Output only. The time at which the instance was created. "displayName": "A String", # Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. + "edition": "A String", # Optional. The `Edition` of the current instance. "endpointUris": [ # Deprecated. This field is not populated. "A String", ], @@ -494,8 +498,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. - "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). - "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "nodeCount": 42, # The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). + "processingUnits": 42, # The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). "state": "A String", # Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. "updateTime": "A String", # Output only. The time at which the instance was most recently updated. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html index ffcc45a4ee5..57e2fecf1a9 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html @@ -160,7 +160,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -249,7 +249,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -445,7 +445,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -534,7 +534,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -670,7 +670,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -759,7 +759,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html index 329074ac357..930fc4b5be5 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html @@ -210,7 +210,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -356,7 +356,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.html b/docs/dyn/vmmigration_v1.projects.locations.sources.html index f7cd8e0e4b8..dd8b6a90120 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.html @@ -79,11 +79,6 @@

Instance Methods

Returns the datacenterConnectors Resource.

-

- diskMigrationJobs() -

-

Returns the diskMigrationJobs Resource.

-

migratingVms()

@@ -165,10 +160,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, @@ -446,10 +437,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, @@ -546,10 +533,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, @@ -653,10 +636,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html index 40ed69337fb..801cf8f8a29 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -170,6 +170,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -186,6 +187,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -204,7 +207,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -312,6 +315,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -328,6 +332,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -346,7 +352,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -430,6 +436,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -446,6 +453,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -464,7 +473,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index 7921a1d4678..90992013082 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -170,6 +170,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -186,6 +187,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -204,7 +207,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -422,6 +425,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -438,6 +442,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -456,7 +462,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -650,6 +656,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -666,6 +673,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -684,7 +693,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 0d8c33e63af..9998f422ee0 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -221,6 +221,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -238,7 +240,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -259,6 +261,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -275,6 +278,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -293,7 +298,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -464,6 +469,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -480,6 +486,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -498,7 +506,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -562,6 +570,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -578,6 +587,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -596,7 +607,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -980,6 +991,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -997,7 +1010,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1018,6 +1031,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -1034,6 +1048,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1052,7 +1068,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1223,6 +1239,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -1239,6 +1256,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1257,7 +1276,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1321,6 +1340,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -1337,6 +1357,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1355,7 +1377,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1639,6 +1661,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1656,7 +1680,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1677,6 +1701,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -1693,6 +1718,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1711,7 +1738,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1882,6 +1909,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -1898,6 +1926,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1916,7 +1946,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1980,6 +2010,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -1996,6 +2027,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2014,7 +2047,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2302,6 +2335,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2319,7 +2354,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2340,6 +2375,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -2356,6 +2392,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2374,7 +2412,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2545,6 +2583,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -2561,6 +2600,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2579,7 +2620,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2643,6 +2684,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "minNodeCpus": 42, # The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured. @@ -2659,6 +2701,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2677,7 +2721,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html index e82d184fee6..69d3d23462d 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html @@ -160,7 +160,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -249,7 +249,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -445,7 +445,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -534,7 +534,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -670,7 +670,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -759,7 +759,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html index a2ee38786f9..72ff10b6524 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html @@ -210,7 +210,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -356,7 +356,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html index 6c8b70a52c6..f5e1c7495e2 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.html @@ -79,11 +79,6 @@

Instance Methods

Returns the datacenterConnectors Resource.

-

- diskMigrationJobs() -

-

Returns the diskMigrationJobs Resource.

-

migratingVms()

@@ -165,10 +160,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, @@ -456,10 +447,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, @@ -565,10 +552,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, @@ -681,10 +664,6 @@

Method Details

"migrationResourcesUserTags": { # User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`. "a_key": "A String", }, - "networkInsights": { # Information about the network coniguration of the source. # Output only. Information about the network coniguration of the source. Only gatherred upon request. - "sourceNetworkConfig": "A String", # Output only. The gathered network configuration of the source. Presented in json format. - "sourceNetworkTerraform": "A String", # Output only. The gathered network configuration of the source. Presented in terraform format. - }, "publicIp": "A String", # Output only. The source's public IP. All communication initiated by this source will originate from this IP. "state": "A String", # Output only. State of the source as determined by the health check. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html index 1edd4ae2b95..f2421e3fb5b 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -170,6 +170,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -187,6 +188,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -205,7 +208,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -258,7 +261,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -338,7 +341,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -421,6 +424,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -438,6 +442,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -456,7 +462,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -509,7 +515,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -589,7 +595,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -648,6 +654,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -665,6 +672,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -683,7 +692,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -736,7 +745,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -816,7 +825,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html index 2f6a4a3ad2e..32170d0483c 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -170,6 +170,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -187,6 +188,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -205,7 +208,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -258,7 +261,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -451,7 +454,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -534,6 +537,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -551,6 +555,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -569,7 +575,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -622,7 +628,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -815,7 +821,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -874,6 +880,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -891,6 +898,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -909,7 +918,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -962,7 +971,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1155,7 +1164,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index f504a96590a..16658e1e36f 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -222,6 +222,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -239,7 +241,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -260,6 +262,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -277,6 +280,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -295,7 +300,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -348,7 +353,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -522,6 +527,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -539,6 +545,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -557,7 +565,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -610,7 +618,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -690,7 +698,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -729,6 +737,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -746,6 +755,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -764,7 +775,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -817,7 +828,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1010,7 +1021,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1069,7 +1080,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1314,6 +1325,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1331,7 +1344,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1352,6 +1365,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -1369,6 +1383,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1387,7 +1403,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1440,7 +1456,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1614,6 +1630,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -1631,6 +1648,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1649,7 +1668,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1702,7 +1721,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1782,7 +1801,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1821,6 +1840,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -1838,6 +1858,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -1856,7 +1878,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1909,7 +1931,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2102,7 +2124,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2161,7 +2183,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2306,6 +2328,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2323,7 +2347,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2344,6 +2368,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -2361,6 +2386,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2379,7 +2406,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2432,7 +2459,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2606,6 +2633,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -2623,6 +2651,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2641,7 +2671,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2694,7 +2724,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2774,7 +2804,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2813,6 +2843,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -2830,6 +2861,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -2848,7 +2881,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2901,7 +2934,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3094,7 +3127,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3153,7 +3186,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3302,6 +3335,8 @@

Method Details

"onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance. "restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -3319,7 +3354,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3340,6 +3375,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # Output only. The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -3357,6 +3393,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. Immutable. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -3375,7 +3413,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3428,7 +3466,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3602,6 +3640,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -3619,6 +3658,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -3637,7 +3678,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3690,7 +3731,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3770,7 +3811,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3809,6 +3850,7 @@

Method Details

"osLicense": "A String", # The OS license returned from the adaptation module's report. "type": "A String", # The license type that was used in OS adaptation. }, + "bootConversion": "A String", # Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another. "bootOption": "A String", # The VM Boot Option, as set in the source VM. "computeScheduling": { # Scheduling information for VM on maintenance/restart behaviour and node allocation in sole tenant nodes. # Compute instance scheduling information (if empty default is used). "automaticRestart": True or False, @@ -3826,6 +3868,8 @@

Method Details

"restartType": "A String", # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to `automaticRestart` field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart. }, "diskType": "A String", # The disk type to use in the VM. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance has integrity monitoring enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance has vTPM enabled. "encryption": { # Encryption message describes the details of the applied encryption. # Optional. The encryption to apply to the VM disks. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, @@ -3844,7 +3888,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3897,7 +3941,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -4090,7 +4134,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -4149,7 +4193,7 @@

Method Details

"externalIp": "A String", # Optional. The external IP to define in the NIC. "internalIp": "A String", # Optional. The internal IP to define in the NIC. The formats accepted are: `ephemeral` \ ipv4 address \ a named address resource full path. "network": "A String", # The network to connect the NIC to. - "networkTier": "A String", # Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + "networkTier": "A String", # Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/youtube_v3.liveChatMessages.html b/docs/dyn/youtube_v3.liveChatMessages.html index 131b9c6f594..6f25ce39085 100644 --- a/docs/dyn/youtube_v3.liveChatMessages.html +++ b/docs/dyn/youtube_v3.liveChatMessages.html @@ -329,7 +329,7 @@

Method Details

Args: liveChatId: string, The id of the live chat for which comments should be returned. (required) - part: string, The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet. (required) (repeated) + part: string, The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails. (required) (repeated) hl: string, Specifies the localization language in which the system messages should be returned. maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved. diff --git a/docs/dyn/youtube_v3.playlists.html b/docs/dyn/youtube_v3.playlists.html index dd2e9482e83..1754b49b85f 100644 --- a/docs/dyn/youtube_v3.playlists.html +++ b/docs/dyn/youtube_v3.playlists.html @@ -181,6 +181,7 @@

Method Details

"title": "A String", # The playlist's title. }, "status": { # The status object contains status information for the playlist. + "podcastStatus": "A String", # The playlist's podcast status. "privacyStatus": "A String", # The playlist's privacy status. }, } @@ -255,6 +256,7 @@

Method Details

"title": "A String", # The playlist's title. }, "status": { # The status object contains status information for the playlist. + "podcastStatus": "A String", # The playlist's podcast status. "privacyStatus": "A String", # The playlist's privacy status. }, }
@@ -346,6 +348,7 @@

Method Details

"title": "A String", # The playlist's title. }, "status": { # The status object contains status information for the playlist. + "podcastStatus": "A String", # The playlist's podcast status. "privacyStatus": "A String", # The playlist's privacy status. }, }, @@ -446,6 +449,7 @@

Method Details

"title": "A String", # The playlist's title. }, "status": { # The status object contains status information for the playlist. + "podcastStatus": "A String", # The playlist's podcast status. "privacyStatus": "A String", # The playlist's privacy status. }, } @@ -519,6 +523,7 @@

Method Details

"title": "A String", # The playlist's title. }, "status": { # The status object contains status information for the playlist. + "podcastStatus": "A String", # The playlist's podcast status. "privacyStatus": "A String", # The playlist's privacy status. }, }
diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 5e2efc129f8..ec6c3193e80 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20240716", +"revision": "20240811", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1705,7 +1705,7 @@ "id": "EgressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", +"description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -1904,7 +1904,7 @@ "id": "IngressFrom", "properties": { "identities": { -"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", +"description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index b7507bbf6af..d3dbb4345f0 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -16928,6 +16928,11 @@ "name" ], "parameters": { +"huggingFaceToken": { +"description": "Optional. Token used to access Hugging Face gated models.", +"location": "query", +"type": "string" +}, "isHuggingFaceModel": { "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", "location": "query", @@ -16976,7 +16981,7 @@ } } }, -"revision": "20240727", +"revision": "20240809", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -18559,6 +18564,12 @@ "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1Candidate", "properties": { +"avgLogprobs": { +"description": "Output only. Average log probability score of the candidate.", +"format": "double", +"readOnly": true, +"type": "number" +}, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1CitationMetadata", "description": "Output only. Source attribution of the generated content.", @@ -20717,6 +20728,16 @@ "format": "int32", "type": "integer" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Timestamp when this EntityType was most recently updated.", "format": "google-datetime", @@ -20825,6 +20846,10 @@ "$ref": "GoogleCloudAiplatformV1GroundednessInput", "description": "Input for groundedness metric." }, +"pairwiseMetricInput": { +"$ref": "GoogleCloudAiplatformV1PairwiseMetricInput", +"description": "Input for pairwise metric." +}, "pairwiseQuestionAnsweringQualityInput": { "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", "description": "Input for pairwise question answering quality metric." @@ -20833,6 +20858,10 @@ "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput", "description": "Input for pairwise summarization quality metric." }, +"pointwiseMetricInput": { +"$ref": "GoogleCloudAiplatformV1PointwiseMetricInput", +"description": "Input for pointwise metric." +}, "questionAnsweringCorrectnessInput": { "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput", "description": "Input for question answering correctness metric." @@ -20916,6 +20945,10 @@ "$ref": "GoogleCloudAiplatformV1GroundednessResult", "description": "Result for groundedness metric." }, +"pairwiseMetricResult": { +"$ref": "GoogleCloudAiplatformV1PairwiseMetricResult", +"description": "Result for pairwise metric." +}, "pairwiseQuestionAnsweringQualityResult": { "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult", "description": "Result for pairwise question answering quality metric." @@ -20924,6 +20957,10 @@ "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult", "description": "Result for pairwise summarization quality metric." }, +"pointwiseMetricResult": { +"$ref": "GoogleCloudAiplatformV1PointwiseMetricResult", +"description": "Generic metrics. Result for pointwise metric." +}, "questionAnsweringCorrectnessResult": { "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult", "description": "Result for question answering correctness metric." @@ -22242,6 +22279,20 @@ "type": "string" }, "type": "array" +}, +"timeSeries": { +"$ref": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", +"description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries": { +"id": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", +"properties": { +"timestampColumn": { +"description": "Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used.", +"type": "string" } }, "type": "object" @@ -22344,6 +22395,16 @@ "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized", "description": "Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default." }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. State of the featureOnlineStore.", "enum": [ @@ -22613,6 +22674,16 @@ "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "syncConfig": { "$ref": "GoogleCloudAiplatformV1FeatureViewSyncConfig", "description": "Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving." @@ -22802,6 +22873,16 @@ "description": "Output only. Time when this FeatureViewSync is finished.", "readOnly": true }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "syncSummary": { "$ref": "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary", "description": "Output only. Summary of the sync job.", @@ -22879,6 +22960,16 @@ "format": "int32", "type": "integer" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. State of the featurestore.", "enum": [ @@ -23459,7 +23550,7 @@ ], "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.", +"Default model behavior, model decides to predict either a function call or a natural language response.", "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." ], @@ -23644,7 +23735,7 @@ "type": "integer" }, "promptTokenCount": { -"description": "Number of tokens in the request.", +"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, @@ -23691,6 +23782,11 @@ "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, +"seed": { +"description": "Optional. Seed.", +"format": "int32", +"type": "integer" +}, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -24404,6 +24500,16 @@ "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.", "format": "google-datetime", @@ -24629,6 +24735,16 @@ "description": "Optional. If true, the deployed index will be accessible through public endpoint.", "type": "boolean" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.", "format": "google-datetime", @@ -26653,6 +26769,16 @@ false "description": "Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.", "type": "any" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "scheduleState": { "description": "Output only. Schedule state when the monitoring job is in Running state.", "enum": [ @@ -28544,6 +28670,72 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1PairwiseMetricInput": { +"description": "Input for pairwise metric.", +"id": "GoogleCloudAiplatformV1PairwiseMetricInput", +"properties": { +"instance": { +"$ref": "GoogleCloudAiplatformV1PairwiseMetricInstance", +"description": "Required. Pairwise metric instance." +}, +"metricSpec": { +"$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", +"description": "Required. Spec for pairwise metric." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1PairwiseMetricInstance": { +"description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", +"id": "GoogleCloudAiplatformV1PairwiseMetricInstance", +"properties": { +"jsonInstance": { +"description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1PairwiseMetricResult": { +"description": "Spec for pairwise metric result.", +"id": "GoogleCloudAiplatformV1PairwiseMetricResult", +"properties": { +"explanation": { +"description": "Output only. Explanation for pairwise metric score.", +"readOnly": true, +"type": "string" +}, +"pairwiseChoice": { +"description": "Output only. Pairwise metric choice.", +"enum": [ +"PAIRWISE_CHOICE_UNSPECIFIED", +"BASELINE", +"CANDIDATE", +"TIE" +], +"enumDescriptions": [ +"Unspecified prediction choice.", +"Baseline prediction wins", +"Candidate prediction wins", +"Winner cannot be determined" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1PairwiseMetricSpec": { +"description": "Spec for pairwise metric.", +"id": "GoogleCloudAiplatformV1PairwiseMetricSpec", +"properties": { +"metricPromptTemplate": { +"description": "Required. Metric prompt template for pairwise metric.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput": { "description": "Input for pairwise question answering quality metric.", "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", @@ -29357,6 +29549,61 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1PointwiseMetricInput": { +"description": "Input for pointwise metric.", +"id": "GoogleCloudAiplatformV1PointwiseMetricInput", +"properties": { +"instance": { +"$ref": "GoogleCloudAiplatformV1PointwiseMetricInstance", +"description": "Required. Pointwise metric instance." +}, +"metricSpec": { +"$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", +"description": "Required. Spec for pointwise metric." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1PointwiseMetricInstance": { +"description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", +"id": "GoogleCloudAiplatformV1PointwiseMetricInstance", +"properties": { +"jsonInstance": { +"description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1PointwiseMetricResult": { +"description": "Spec for pointwise metric result.", +"id": "GoogleCloudAiplatformV1PointwiseMetricResult", +"properties": { +"explanation": { +"description": "Output only. Explanation for pointwise metric score.", +"readOnly": true, +"type": "string" +}, +"score": { +"description": "Output only. Pointwise metric score.", +"format": "float", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1PointwiseMetricSpec": { +"description": "Spec for pointwise metric.", +"id": "GoogleCloudAiplatformV1PointwiseMetricSpec", +"properties": { +"metricPromptTemplate": { +"description": "Required. Metric prompt template for pointwise metric.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1Port": { "description": "Represents a network port in a container.", "id": "GoogleCloudAiplatformV1Port", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 463039de04d..34de6a8f8ea 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -20336,6 +20336,11 @@ "name" ], "parameters": { +"huggingFaceToken": { +"description": "Optional. Token used to access Hugging Face gated models.", +"location": "query", +"type": "string" +}, "isHuggingFaceModel": { "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", "location": "query", @@ -20452,7 +20457,7 @@ } } }, -"revision": "20240727", +"revision": "20240809", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -22304,6 +22309,12 @@ "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { +"avgLogprobs": { +"description": "Output only. Average log probability score of the candidate.", +"format": "double", +"readOnly": true, +"type": "number" +}, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", "description": "Output only. Source attribution of the generated content.", @@ -24770,6 +24781,16 @@ "format": "int32", "type": "integer" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Timestamp when this EntityType was most recently updated.", "format": "google-datetime", @@ -24878,6 +24899,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundednessInput", "description": "Input for groundedness metric." }, +"pairwiseMetricInput": { +"$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricInput", +"description": "Input for pairwise metric." +}, "pairwiseQuestionAnsweringQualityInput": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput", "description": "Input for pairwise question answering quality metric." @@ -24886,6 +24911,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput", "description": "Input for pairwise summarization quality metric." }, +"pointwiseMetricInput": { +"$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricInput", +"description": "Input for pointwise metric." +}, "questionAnsweringCorrectnessInput": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput", "description": "Input for question answering correctness metric." @@ -24969,6 +24998,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundednessResult", "description": "Result for groundedness metric." }, +"pairwiseMetricResult": { +"$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", +"description": "Result for pairwise metric." +}, "pairwiseQuestionAnsweringQualityResult": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult", "description": "Result for pairwise question answering quality metric." @@ -24977,6 +25010,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult", "description": "Result for pairwise summarization quality metric." }, +"pointwiseMetricResult": { +"$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", +"description": "Generic metrics. Result for pointwise metric." +}, "questionAnsweringCorrectnessResult": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult", "description": "Result for question answering correctness metric." @@ -26454,6 +26491,20 @@ "type": "string" }, "type": "array" +}, +"timeSeries": { +"$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", +"description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries": { +"id": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", +"properties": { +"timestampColumn": { +"description": "Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used.", +"type": "string" } }, "type": "object" @@ -26561,6 +26612,16 @@ "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized", "description": "Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default." }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. State of the featureOnlineStore.", "enum": [ @@ -26842,6 +26903,16 @@ "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "serviceAccountEmail": { "description": "Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store.", "readOnly": true, @@ -27055,6 +27126,16 @@ "description": "Output only. Time when this FeatureViewSync is finished.", "readOnly": true }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "syncSummary": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary", "description": "Output only. Summary of the sync job.", @@ -27200,6 +27281,16 @@ "format": "int32", "type": "integer" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "state": { "description": "Output only. State of the featurestore.", "enum": [ @@ -27806,7 +27897,7 @@ ], "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.", +"Default model behavior, model decides to predict either a function call or a natural language response.", "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." ], @@ -28034,7 +28125,7 @@ "type": "integer" }, "promptTokenCount": { -"description": "Number of tokens in the request.", +"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, @@ -28107,6 +28198,11 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, +"seed": { +"description": "Optional. Seed.", +"format": "int32", +"type": "integer" +}, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -28829,6 +28925,10 @@ "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after importing RagFiles." }, +"ragFileParsingConfig": { +"$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", +"description": "Specifies the parsing config for RagFiles." +}, "slackSource": { "$ref": "GoogleCloudAiplatformV1beta1SlackSource", "description": "Slack channels with their corresponding access tokens." @@ -28920,6 +29020,16 @@ "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.", "format": "google-datetime", @@ -29145,6 +29255,16 @@ "description": "Optional. If true, the deployed index will be accessible through public endpoint.", "type": "boolean" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.", "format": "google-datetime", @@ -31366,6 +31486,16 @@ false "description": "Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.", "type": "any" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "scheduleState": { "description": "Output only. Schedule state when the monitoring job is in Running state.", "enum": [ @@ -34069,6 +34199,72 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1PairwiseMetricInput": { +"description": "Input for pairwise metric.", +"id": "GoogleCloudAiplatformV1beta1PairwiseMetricInput", +"properties": { +"instance": { +"$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance", +"description": "Required. Pairwise metric instance." +}, +"metricSpec": { +"$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", +"description": "Required. Spec for pairwise metric." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1PairwiseMetricInstance": { +"description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", +"id": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance", +"properties": { +"jsonInstance": { +"description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1PairwiseMetricResult": { +"description": "Spec for pairwise metric result.", +"id": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", +"properties": { +"explanation": { +"description": "Output only. Explanation for pairwise metric score.", +"readOnly": true, +"type": "string" +}, +"pairwiseChoice": { +"description": "Output only. Pairwise metric choice.", +"enum": [ +"PAIRWISE_CHOICE_UNSPECIFIED", +"BASELINE", +"CANDIDATE", +"TIE" +], +"enumDescriptions": [ +"Unspecified prediction choice.", +"Baseline prediction wins", +"Candidate prediction wins", +"Winner cannot be determined" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1PairwiseMetricSpec": { +"description": "Spec for pairwise metric.", +"id": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", +"properties": { +"metricPromptTemplate": { +"description": "Required. Metric prompt template for pairwise metric.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput": { "description": "Input for pairwise question answering quality metric.", "id": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput", @@ -34896,6 +35092,61 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1PointwiseMetricInput": { +"description": "Input for pointwise metric.", +"id": "GoogleCloudAiplatformV1beta1PointwiseMetricInput", +"properties": { +"instance": { +"$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance", +"description": "Required. Pointwise metric instance." +}, +"metricSpec": { +"$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", +"description": "Required. Spec for pointwise metric." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1PointwiseMetricInstance": { +"description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", +"id": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance", +"properties": { +"jsonInstance": { +"description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1PointwiseMetricResult": { +"description": "Spec for pointwise metric result.", +"id": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", +"properties": { +"explanation": { +"description": "Output only. Explanation for pointwise metric score.", +"readOnly": true, +"type": "string" +}, +"score": { +"description": "Output only. Pointwise metric score.", +"format": "float", +"readOnly": true, +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1PointwiseMetricSpec": { +"description": "Spec for pointwise metric.", +"id": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", +"properties": { +"metricPromptTemplate": { +"description": "Required. Metric prompt template for pointwise metric.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Port": { "description": "Represents a network port in a container.", "id": "GoogleCloudAiplatformV1beta1Port", @@ -36375,6 +36626,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RagFileParsingConfig": { +"description": "Specifies the parsing config for RagFiles.", +"id": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", +"properties": { +"parsePdfsUsingOcr": { +"description": "Whether to use OCR for PDFs.", +"type": "boolean" +}, +"useAdvancedPdfParsing": { +"description": "Whether to use advanced PDF parsing.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RagQuery": { "description": "A query to retrieve relevant contexts.", "id": "GoogleCloudAiplatformV1beta1RagQuery", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 6d0d012cdbe..230b9c59fbb 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1489,7 +1489,7 @@ } } }, -"revision": "20240627", +"revision": "20240806", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2001,6 +2001,83 @@ false }, "type": "object" }, +"ClusterUpgradeDetails": { +"description": "Upgrade details of a cluster. This cluster can be primary or secondary.", +"id": "ClusterUpgradeDetails", +"properties": { +"clusterType": { +"description": "Cluster type which can either be primary or secondary.", +"enum": [ +"CLUSTER_TYPE_UNSPECIFIED", +"PRIMARY", +"SECONDARY" +], +"enumDescriptions": [ +"The type of the cluster is unknown.", +"Primary cluster that support read and write operations.", +"Secondary cluster that is replicating from another region. This only supports read." +], +"type": "string" +}, +"databaseVersion": { +"description": "Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.", +"enum": [ +"DATABASE_VERSION_UNSPECIFIED", +"POSTGRES_13", +"POSTGRES_14", +"POSTGRES_15" +], +"enumDeprecated": [ +false, +true, +false, +false +], +"enumDescriptions": [ +"This is an unknown database version.", +"DEPRECATED - The database version is Postgres 13.", +"The database version is Postgres 14.", +"The database version is Postgres 15." +], +"type": "string" +}, +"instanceUpgradeDetails": { +"description": "Upgrade details of the instances directly associated with this cluster.", +"items": { +"$ref": "InstanceUpgradeDetails" +}, +"type": "array" +}, +"name": { +"description": "Normalized name of the cluster", +"type": "string" +}, +"stageInfo": { +"description": "Array containing stage info associated with this cluster.", +"items": { +"$ref": "StageInfo" +}, +"type": "array" +}, +"upgradeStatus": { +"description": "Upgrade status of the cluster.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "ConnectionInfo": { "description": "ConnectionInfo singleton resource. https://google.aip.dev/156", "id": "ConnectionInfo", @@ -2483,6 +2560,49 @@ false }, "type": "object" }, +"InstanceUpgradeDetails": { +"description": "Details regarding the upgrade of instaces associated with a cluster.", +"id": "InstanceUpgradeDetails", +"properties": { +"instanceType": { +"description": "Instance type.", +"enum": [ +"INSTANCE_TYPE_UNSPECIFIED", +"PRIMARY", +"READ_POOL", +"SECONDARY" +], +"enumDescriptions": [ +"The type of the instance is unknown.", +"PRIMARY instances support read and write operations.", +"READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).", +"SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica" +], +"type": "string" +}, +"name": { +"description": "Normalized name of the instance.", +"type": "string" +}, +"upgradeStatus": { +"description": "Upgrade status of the instance.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "IntegerRestrictions": { "description": "Restrictions on INTEGER type values.", "id": "IntegerRestrictions", @@ -2997,6 +3117,13 @@ false "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { +"nodeIds": { +"description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", +"items": { +"type": "string" +}, +"type": "array" +}, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" @@ -3097,6 +3224,51 @@ false }, "type": "object" }, +"StageInfo": { +"description": "Stage information for different stages in the upgrade process.", +"id": "StageInfo", +"properties": { +"logsUrl": { +"description": "logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.", +"type": "string" +}, +"stage": { +"description": "The stage.", +"enum": [ +"STAGE_UNSPECIFIED", +"ALLOYDB_PRECHECK", +"PG_UPGRADE_CHECK", +"PRIMARY_INSTANCE_UPGRADE", +"READ_POOL_UPGRADE" +], +"enumDescriptions": [ +"Unspecified stage.", +"This stage is for the custom checks done before upgrade.", +"This stage is for `pg_upgrade --check` run before upgrade.", +"This stage is primary upgrade.", +"This stage is read pool upgrade." +], +"type": "string" +}, +"status": { +"description": "Status of the stage.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -3229,43 +3401,19 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { -"description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { -"databaseMetadata": { +"internalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", "items": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata" +"$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, "type": "array" } }, "type": "object" }, -"StorageDatabasecenterPartnerapiV1mainDatabaseMetadata": { -"description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", -"id": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata", -"properties": { -"backupConfiguration": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this database" -}, -"backupRun": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Information about the last backup attempt for this database" -}, -"product": { -"$ref": "StorageDatabasecenterProtoCommonProduct" -}, -"resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" -}, -"resourceName": { -"description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", -"type": "string" -} -}, -"type": "object" -}, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -3294,8 +3442,7 @@ false "type": "string" }, "observabilityMetricData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" @@ -3404,6 +3551,24 @@ false "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, +"signalSeverity": { +"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"enum": [ +"SIGNAL_SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"This value is used for findings when a source doesn't write a severity value.", +"A critical vulnerability is easily discoverable by an external actor, exploitable.", +"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", +"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", +"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +], +"type": "string" +}, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -3700,7 +3865,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -4198,6 +4363,31 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", +"properties": { +"backupConfiguration": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", +"description": "Backup configuration for this database" +}, +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"description": "Information about the last backup attempt for this database" +}, +"product": { +"$ref": "StorageDatabasecenterProtoCommonProduct" +}, +"resourceId": { +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" +}, +"resourceName": { +"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"type": "string" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -4371,7 +4561,9 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_OTHER" +"ENGINE_OTHER", +"ENGINE_FIRESTORE_WITH_NATIVE_MODE", +"ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -4387,6 +4579,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -4403,7 +4597,9 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." +"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", +"Firestore with native mode.", +"Firestore with datastore mode." ], "type": "string" }, @@ -4420,7 +4616,8 @@ false "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", -"PRODUCT_TYPE_OTHER" +"PRODUCT_TYPE_OTHER", +"PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -4433,6 +4630,7 @@ false, true, false, false, +false, false ], "enumDescriptions": [ @@ -4446,7 +4644,8 @@ false "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", -"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." +"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", +"Firestore product area in GCP." ], "type": "string" }, @@ -4605,6 +4804,11 @@ false "format": "google-datetime", "type": "string" }, +"graceEndTime": { +"description": "grace end time of the cluster.", +"format": "google-datetime", +"type": "string" +}, "startTime": { "description": "start time of the trial cluster.", "format": "google-datetime", @@ -4618,6 +4822,40 @@ false }, "type": "object" }, +"UpgradeClusterResponse": { +"description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", +"id": "UpgradeClusterResponse", +"properties": { +"clusterUpgradeDetails": { +"description": "Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.", +"items": { +"$ref": "ClusterUpgradeDetails" +}, +"type": "array" +}, +"message": { +"description": "A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.", +"type": "string" +}, +"status": { +"description": "Status of upgrade operation.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "User": { "description": "Message describing User object.", "id": "User", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 737b0921ed2..f817060f7af 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -735,6 +735,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"upgrade": { +"description": "Upgrades a single Cluster. Imperative only.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade", +"httpMethod": "PATCH", +"id": "alloydb.projects.locations.clusters.upgrade", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the cluster.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:upgrade", +"request": { +"$ref": "UpgradeClusterRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -1489,7 +1517,7 @@ } } }, -"revision": "20240703", +"revision": "20240806", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1786,6 +1814,26 @@ false }, "type": "object" }, +"CloudSQLBackupRunSource": { +"description": "The source CloudSQL backup resource.", +"id": "CloudSQLBackupRunSource", +"properties": { +"backupRunId": { +"description": "Required. The CloudSQL backup run ID.", +"format": "int64", +"type": "string" +}, +"instanceId": { +"description": "Required. The CloudSQL instance ID.", +"type": "string" +}, +"project": { +"description": "The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.", +"type": "string" +} +}, +"type": "object" +}, "Cluster": { "description": "A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.", "id": "Cluster", @@ -1806,6 +1854,11 @@ false "description": "Output only. Cluster created from backup.", "readOnly": true }, +"cloudsqlBackupRunSource": { +"$ref": "CloudSQLBackupRunSource", +"description": "Output only. Cluster created from CloudSQL snapshot.", +"readOnly": true +}, "clusterType": { "description": "Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`", "enum": [ @@ -2021,6 +2074,86 @@ false }, "type": "object" }, +"ClusterUpgradeDetails": { +"description": "Upgrade details of a cluster. This cluster can be primary or secondary.", +"id": "ClusterUpgradeDetails", +"properties": { +"clusterType": { +"description": "Cluster type which can either be primary or secondary.", +"enum": [ +"CLUSTER_TYPE_UNSPECIFIED", +"PRIMARY", +"SECONDARY" +], +"enumDescriptions": [ +"The type of the cluster is unknown.", +"Primary cluster that support read and write operations.", +"Secondary cluster that is replicating from another region. This only supports read." +], +"type": "string" +}, +"databaseVersion": { +"description": "Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.", +"enum": [ +"DATABASE_VERSION_UNSPECIFIED", +"POSTGRES_13", +"POSTGRES_14", +"POSTGRES_15", +"POSTGRES_16" +], +"enumDeprecated": [ +false, +true, +false, +false, +false +], +"enumDescriptions": [ +"This is an unknown database version.", +"DEPRECATED - The database version is Postgres 13.", +"The database version is Postgres 14.", +"The database version is Postgres 15.", +"The database version is Postgres 16." +], +"type": "string" +}, +"instanceUpgradeDetails": { +"description": "Upgrade details of the instances directly associated with this cluster.", +"items": { +"$ref": "InstanceUpgradeDetails" +}, +"type": "array" +}, +"name": { +"description": "Normalized name of the cluster", +"type": "string" +}, +"stageInfo": { +"description": "Array containing stage info associated with this cluster.", +"items": { +"$ref": "StageInfo" +}, +"type": "array" +}, +"upgradeStatus": { +"description": "Upgrade status of the cluster.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "ConnectionInfo": { "description": "ConnectionInfo singleton resource. https://google.aip.dev/156", "id": "ConnectionInfo", @@ -2570,6 +2703,49 @@ false }, "type": "object" }, +"InstanceUpgradeDetails": { +"description": "Details regarding the upgrade of instaces associated with a cluster.", +"id": "InstanceUpgradeDetails", +"properties": { +"instanceType": { +"description": "Instance type.", +"enum": [ +"INSTANCE_TYPE_UNSPECIFIED", +"PRIMARY", +"READ_POOL", +"SECONDARY" +], +"enumDescriptions": [ +"The type of the instance is unknown.", +"PRIMARY instances support read and write operations.", +"READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).", +"SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica" +], +"type": "string" +}, +"name": { +"description": "Normalized name of the instance.", +"type": "string" +}, +"upgradeStatus": { +"description": "Upgrade status of the instance.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "IntegerRestrictions": { "description": "Restrictions on INTEGER type values.", "id": "IntegerRestrictions", @@ -2895,6 +3071,10 @@ false "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", "type": "boolean" }, +"trackClientAddress": { +"description": "Track client address for an instance. If not set, default value is \"off\".", +"type": "boolean" +}, "trackWaitEventTypes": { "description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.", "readOnly": true, @@ -3126,6 +3306,13 @@ false "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { +"nodeIds": { +"description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", +"items": { +"type": "string" +}, +"type": "array" +}, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" @@ -3226,6 +3413,51 @@ false }, "type": "object" }, +"StageInfo": { +"description": "Stage information for different stages in the upgrade process.", +"id": "StageInfo", +"properties": { +"logsUrl": { +"description": "logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.", +"type": "string" +}, +"stage": { +"description": "The stage.", +"enum": [ +"STAGE_UNSPECIFIED", +"ALLOYDB_PRECHECK", +"PG_UPGRADE_CHECK", +"PRIMARY_INSTANCE_UPGRADE", +"READ_POOL_UPGRADE" +], +"enumDescriptions": [ +"Unspecified stage.", +"This stage is for the custom checks done before upgrade.", +"This stage is for `pg_upgrade --check` run before upgrade.", +"This stage is primary upgrade.", +"This stage is read pool upgrade." +], +"type": "string" +}, +"status": { +"description": "Status of the stage.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -3358,43 +3590,19 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { -"description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { -"databaseMetadata": { +"internalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", "items": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata" +"$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, "type": "array" } }, "type": "object" }, -"StorageDatabasecenterPartnerapiV1mainDatabaseMetadata": { -"description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", -"id": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata", -"properties": { -"backupConfiguration": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this database" -}, -"backupRun": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Information about the last backup attempt for this database" -}, -"product": { -"$ref": "StorageDatabasecenterProtoCommonProduct" -}, -"resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" -}, -"resourceName": { -"description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", -"type": "string" -} -}, -"type": "object" -}, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -3423,8 +3631,7 @@ false "type": "string" }, "observabilityMetricData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" @@ -3533,6 +3740,24 @@ false "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, +"signalSeverity": { +"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"enum": [ +"SIGNAL_SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"This value is used for findings when a source doesn't write a severity value.", +"A critical vulnerability is easily discoverable by an external actor, exploitable.", +"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", +"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", +"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +], +"type": "string" +}, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -3829,7 +4054,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -4327,6 +4552,31 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", +"properties": { +"backupConfiguration": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", +"description": "Backup configuration for this database" +}, +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"description": "Information about the last backup attempt for this database" +}, +"product": { +"$ref": "StorageDatabasecenterProtoCommonProduct" +}, +"resourceId": { +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" +}, +"resourceName": { +"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"type": "string" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -4500,7 +4750,9 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_OTHER" +"ENGINE_OTHER", +"ENGINE_FIRESTORE_WITH_NATIVE_MODE", +"ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -4516,6 +4768,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -4532,7 +4786,9 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." +"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", +"Firestore with native mode.", +"Firestore with datastore mode." ], "type": "string" }, @@ -4549,7 +4805,8 @@ false "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", -"PRODUCT_TYPE_OTHER" +"PRODUCT_TYPE_OTHER", +"PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -4562,6 +4819,7 @@ false, true, false, false, +false, false ], "enumDescriptions": [ @@ -4575,7 +4833,8 @@ false "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", -"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." +"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", +"Firestore product area in GCP." ], "type": "string" }, @@ -4737,6 +4996,11 @@ false "format": "google-datetime", "type": "string" }, +"graceEndTime": { +"description": "grace end time of the cluster.", +"format": "google-datetime", +"type": "string" +}, "startTime": { "description": "start time of the trial cluster.", "format": "google-datetime", @@ -4771,6 +5035,84 @@ false }, "type": "object" }, +"UpgradeClusterRequest": { +"description": "Upgrades a cluster.", +"id": "UpgradeClusterRequest", +"properties": { +"etag": { +"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.", +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.", +"type": "boolean" +}, +"version": { +"description": "Required. The version the cluster is going to be upgraded to.", +"enum": [ +"DATABASE_VERSION_UNSPECIFIED", +"POSTGRES_13", +"POSTGRES_14", +"POSTGRES_15", +"POSTGRES_16" +], +"enumDeprecated": [ +false, +true, +false, +false, +false +], +"enumDescriptions": [ +"This is an unknown database version.", +"DEPRECATED - The database version is Postgres 13.", +"The database version is Postgres 14.", +"The database version is Postgres 15.", +"The database version is Postgres 16." +], +"type": "string" +} +}, +"type": "object" +}, +"UpgradeClusterResponse": { +"description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", +"id": "UpgradeClusterResponse", +"properties": { +"clusterUpgradeDetails": { +"description": "Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.", +"items": { +"$ref": "ClusterUpgradeDetails" +}, +"type": "array" +}, +"message": { +"description": "A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.", +"type": "string" +}, +"status": { +"description": "Status of upgrade operation.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "User": { "description": "Message describing User object.", "id": "User", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 075b0bfcc0b..db5c28a05b3 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1486,7 +1486,7 @@ } } }, -"revision": "20240703", +"revision": "20240806", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1772,6 +1772,26 @@ false }, "type": "object" }, +"CloudSQLBackupRunSource": { +"description": "The source CloudSQL backup resource.", +"id": "CloudSQLBackupRunSource", +"properties": { +"backupRunId": { +"description": "Required. The CloudSQL backup run ID.", +"format": "int64", +"type": "string" +}, +"instanceId": { +"description": "Required. The CloudSQL instance ID.", +"type": "string" +}, +"project": { +"description": "The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.", +"type": "string" +} +}, +"type": "object" +}, "Cluster": { "description": "A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.", "id": "Cluster", @@ -1792,6 +1812,11 @@ false "description": "Output only. Cluster created from backup.", "readOnly": true }, +"cloudsqlBackupRunSource": { +"$ref": "CloudSQLBackupRunSource", +"description": "Output only. Cluster created from CloudSQL snapshot.", +"readOnly": true +}, "clusterType": { "description": "Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`", "enum": [ @@ -2002,6 +2027,86 @@ false }, "type": "object" }, +"ClusterUpgradeDetails": { +"description": "Upgrade details of a cluster. This cluster can be primary or secondary.", +"id": "ClusterUpgradeDetails", +"properties": { +"clusterType": { +"description": "Cluster type which can either be primary or secondary.", +"enum": [ +"CLUSTER_TYPE_UNSPECIFIED", +"PRIMARY", +"SECONDARY" +], +"enumDescriptions": [ +"The type of the cluster is unknown.", +"Primary cluster that support read and write operations.", +"Secondary cluster that is replicating from another region. This only supports read." +], +"type": "string" +}, +"databaseVersion": { +"description": "Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.", +"enum": [ +"DATABASE_VERSION_UNSPECIFIED", +"POSTGRES_13", +"POSTGRES_14", +"POSTGRES_15", +"POSTGRES_16" +], +"enumDeprecated": [ +false, +true, +false, +false, +false +], +"enumDescriptions": [ +"This is an unknown database version.", +"DEPRECATED - The database version is Postgres 13.", +"The database version is Postgres 14.", +"The database version is Postgres 15.", +"The database version is Postgres 16." +], +"type": "string" +}, +"instanceUpgradeDetails": { +"description": "Upgrade details of the instances directly associated with this cluster.", +"items": { +"$ref": "InstanceUpgradeDetails" +}, +"type": "array" +}, +"name": { +"description": "Normalized name of the cluster", +"type": "string" +}, +"stageInfo": { +"description": "Array containing stage info associated with this cluster.", +"items": { +"$ref": "StageInfo" +}, +"type": "array" +}, +"upgradeStatus": { +"description": "Upgrade status of the cluster.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "ConnectionInfo": { "description": "ConnectionInfo singleton resource. https://google.aip.dev/156", "id": "ConnectionInfo", @@ -2546,6 +2651,49 @@ false }, "type": "object" }, +"InstanceUpgradeDetails": { +"description": "Details regarding the upgrade of instaces associated with a cluster.", +"id": "InstanceUpgradeDetails", +"properties": { +"instanceType": { +"description": "Instance type.", +"enum": [ +"INSTANCE_TYPE_UNSPECIFIED", +"PRIMARY", +"READ_POOL", +"SECONDARY" +], +"enumDescriptions": [ +"The type of the instance is unknown.", +"PRIMARY instances support read and write operations.", +"READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).", +"SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica" +], +"type": "string" +}, +"name": { +"description": "Normalized name of the instance.", +"type": "string" +}, +"upgradeStatus": { +"description": "Upgrade status of the instance.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "IntegerRestrictions": { "description": "Restrictions on INTEGER type values.", "id": "IntegerRestrictions", @@ -2871,6 +3019,10 @@ false "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", "type": "boolean" }, +"trackClientAddress": { +"description": "Track client address for an instance. If not set, default value is \"off\".", +"type": "boolean" +}, "trackWaitEventTypes": { "description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.", "readOnly": true, @@ -3102,6 +3254,13 @@ false "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { +"nodeIds": { +"description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", +"items": { +"type": "string" +}, +"type": "array" +}, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" @@ -3202,6 +3361,51 @@ false }, "type": "object" }, +"StageInfo": { +"description": "Stage information for different stages in the upgrade process.", +"id": "StageInfo", +"properties": { +"logsUrl": { +"description": "logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.", +"type": "string" +}, +"stage": { +"description": "The stage.", +"enum": [ +"STAGE_UNSPECIFIED", +"ALLOYDB_PRECHECK", +"PG_UPGRADE_CHECK", +"PRIMARY_INSTANCE_UPGRADE", +"READ_POOL_UPGRADE" +], +"enumDescriptions": [ +"Unspecified stage.", +"This stage is for the custom checks done before upgrade.", +"This stage is for `pg_upgrade --check` run before upgrade.", +"This stage is primary upgrade.", +"This stage is read pool upgrade." +], +"type": "string" +}, +"status": { +"description": "Status of the stage.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -3334,43 +3538,19 @@ false "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { -"description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { -"databaseMetadata": { +"internalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", "items": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata" +"$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, "type": "array" } }, "type": "object" }, -"StorageDatabasecenterPartnerapiV1mainDatabaseMetadata": { -"description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", -"id": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata", -"properties": { -"backupConfiguration": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", -"description": "Backup configuration for this database" -}, -"backupRun": { -"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", -"description": "Information about the last backup attempt for this database" -}, -"product": { -"$ref": "StorageDatabasecenterProtoCommonProduct" -}, -"resourceId": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" -}, -"resourceName": { -"description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", -"type": "string" -} -}, -"type": "object" -}, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -3399,8 +3579,7 @@ false "type": "string" }, "observabilityMetricData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" @@ -3509,6 +3688,24 @@ false "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, +"signalSeverity": { +"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"enum": [ +"SIGNAL_SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"This value is used for findings when a source doesn't write a severity value.", +"A critical vulnerability is easily discoverable by an external actor, exploitable.", +"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", +"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", +"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +], +"type": "string" +}, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -3805,7 +4002,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -4303,6 +4500,31 @@ false }, "type": "object" }, +"StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", +"properties": { +"backupConfiguration": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", +"description": "Backup configuration for this database" +}, +"backupRun": { +"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", +"description": "Information about the last backup attempt for this database" +}, +"product": { +"$ref": "StorageDatabasecenterProtoCommonProduct" +}, +"resourceId": { +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" +}, +"resourceName": { +"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"type": "string" +} +}, +"type": "object" +}, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -4476,7 +4698,9 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_OTHER" +"ENGINE_OTHER", +"ENGINE_FIRESTORE_WITH_NATIVE_MODE", +"ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -4492,6 +4716,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -4508,7 +4734,9 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." +"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", +"Firestore with native mode.", +"Firestore with datastore mode." ], "type": "string" }, @@ -4525,7 +4753,8 @@ false "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", -"PRODUCT_TYPE_OTHER" +"PRODUCT_TYPE_OTHER", +"PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -4538,6 +4767,7 @@ false, true, false, false, +false, false ], "enumDescriptions": [ @@ -4551,7 +4781,8 @@ false "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", -"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." +"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", +"Firestore product area in GCP." ], "type": "string" }, @@ -4713,6 +4944,11 @@ false "format": "google-datetime", "type": "string" }, +"graceEndTime": { +"description": "grace end time of the cluster.", +"format": "google-datetime", +"type": "string" +}, "startTime": { "description": "start time of the trial cluster.", "format": "google-datetime", @@ -4747,6 +4983,40 @@ false }, "type": "object" }, +"UpgradeClusterResponse": { +"description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", +"id": "UpgradeClusterResponse", +"properties": { +"clusterUpgradeDetails": { +"description": "Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.", +"items": { +"$ref": "ClusterUpgradeDetails" +}, +"type": "array" +}, +"message": { +"description": "A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.", +"type": "string" +}, +"status": { +"description": "Status of upgrade operation.", +"enum": [ +"STATUS_UNSPECIFIED", +"SUCCESS", +"FAILED", +"PARTIAL_SUCCESS" +], +"enumDescriptions": [ +"Unspecified status.", +"Operation succeeded.", +"Operation failed.", +"Operation partially succeeded." +], +"type": "string" +} +}, +"type": "object" +}, "User": { "description": "Message describing User object.", "id": "User", diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index e04bfb07a11..ba3a56eec58 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4731,7 +4731,7 @@ } } }, -"revision": "20240806", +"revision": "20240814", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -8249,6 +8249,10 @@ false "description": "Revocation context of the purchases.subscriptionsv2.revoke API.", "id": "RevocationContext", "properties": { +"fullRefund": { +"$ref": "RevocationContextFullRefund", +"description": "Optional. Used when users should be refunded the full amount of the latest order of the subscription." +}, "proratedRefund": { "$ref": "RevocationContextProratedRefund", "description": "Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription." @@ -8256,6 +8260,12 @@ false }, "type": "object" }, +"RevocationContextFullRefund": { +"description": "Used to determine if the refund type in the RevocationContext is a full refund.", +"id": "RevocationContextFullRefund", +"properties": {}, +"type": "object" +}, "RevocationContextProratedRefund": { "description": "Used to determine if the refund type in the RevocationContext is a prorated refund.", "id": "RevocationContextProratedRefund", diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index fb9a07d5593..6069b0de8b7 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, -"revision": "20240623", +"revision": "20240811", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { @@ -502,7 +502,7 @@ "type": "array" }, "service": { -"description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.", +"description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index d19b9a1dee7..9f7a4074e95 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -1034,7 +1034,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name=\"projects/p1/locations/us-central1/repositories/repo1/files/a/b/*\"` --> Files with an ID starting with \"a/b/\". * `owner=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Files owned by the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", "location": "query", "type": "string" }, @@ -1637,7 +1637,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240724", +"revision": "20240809", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index 47770b76588..533f83fd901 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -715,7 +715,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name=\"projects/p1/locations/us-central1/repositories/repo1/files/a/b/*\"` --> Files with an ID starting with \"a/b/\". * `owner=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Files owned by the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", "location": "query", "type": "string" }, @@ -937,7 +937,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1146,7 +1146,7 @@ } } }, -"revision": "20240724", +"revision": "20240809", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index 760df8cc637..ac1d0995082 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -877,7 +877,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` An example of using a filter: * `name=\"projects/p1/locations/us-central1/repositories/repo1/files/a/b/*\"` --> Files with an ID starting with \"a/b/\". * `owner=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Files owned by the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", "location": "query", "type": "string" }, @@ -1133,7 +1133,7 @@ ], "parameters": { "filter": { -"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", +"description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1414,7 +1414,7 @@ } } }, -"revision": "20240724", +"revision": "20240809", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 983cca9708f..99f5ee43015 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -1598,7 +1598,7 @@ } } }, -"revision": "20240731", +"revision": "20240808", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2433,17 +2433,6 @@ "format": "int32", "type": "integer" }, -"backupVault": { -"deprecated": true, -"description": "Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}", -"type": "string" -}, -"backupVaultServiceAccount": { -"deprecated": true, -"description": "Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.", -"readOnly": true, -"type": "string" -}, "ruleId": { "description": "Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.", "type": "string" @@ -4392,12 +4381,6 @@ "description": "Message for rules config info.", "id": "RuleConfigInfo", "properties": { -"dataSource": { -"deprecated": true, -"description": "Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}", -"readOnly": true, -"type": "string" -}, "lastBackupError": { "$ref": "Status", "description": "Output only. Output Only. google.rpc.Status object to store the last backup error.", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index 2809396a69f..ceb2b85f69a 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -1264,7 +1264,10 @@ "path": "v1alpha/{+name}:cancel", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaCancelSubscriptionResponse" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, "create": { "description": "Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.", @@ -1289,7 +1292,10 @@ }, "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, "get": { "description": "Gets details of a single Subscription.", @@ -1311,7 +1317,10 @@ "path": "v1alpha/{+name}", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, "list": { "description": "Lists Subscriptions in a given organization and location.", @@ -1344,7 +1353,10 @@ "path": "v1alpha/{+parent}/subscriptions", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaListSubscriptionsResponse" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, "patch": { "description": "Updates an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.", @@ -1380,7 +1392,10 @@ }, "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, "restart": { "description": "Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective", @@ -1407,7 +1422,10 @@ "path": "v1alpha/{+name}:restart", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaRestartSubscriptionResponse" -} +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -3462,6 +3480,232 @@ } } }, +"global": { +"resources": { +"securityGateways": { +"resources": { +"applications": { +"methods": { +"create": { +"description": "Creates a new Application in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.global.securityGateways.applications.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"applicationId": { +"description": "Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/applications", +"request": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Application.", +"flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}", +"httpMethod": "PATCH", +"id": "beyondcorp.projects.locations.global.securityGateways.applications.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Mutable fields include: display_name.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}:testIamPermissions", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.global.securityGateways.applications.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"hubs": { +"methods": { +"create": { +"description": "Creates a new Hub in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.global.securityGateways.hubs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"hubId": { +"description": "Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/hubs", +"request": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single Hub.", +"flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}", +"httpMethod": "PATCH", +"id": "beyondcorp.projects.locations.global.securityGateways.hubs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Mutable fields include: display_name.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}:testIamPermissions", +"httpMethod": "POST", +"id": "beyondcorp.projects.locations.global.securityGateways.hubs.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, "insights": { "methods": { "configuredInsight": { @@ -4176,31 +4420,253 @@ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} -} -} -} }, -"revision": "20240802", -"rootUrl": "https://beyondcorp.googleapis.com/", -"schemas": { -"AllocatedConnection": { -"description": "Allocated connection of the AppGateway.", -"id": "AllocatedConnection", -"properties": { -"ingressPort": { -"description": "Required. The ingress port of an allocated connection", -"format": "int32", -"type": "integer" +"resources": { +"applications": { +"methods": { +"delete": { +"description": "Deletes a single Application.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", +"httpMethod": "DELETE", +"id": "beyondcorp.projects.locations.securityGateways.applications.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" }, -"pscUri": { -"description": "Required. The PSC uri of an allocated connection", +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", "type": "string" -} }, -"type": "object" +"validateOnly": { +"description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Application.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", +"httpMethod": "GET", +"id": "beyondcorp.projects.locations.securityGateways.applications.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Applications in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", +"httpMethod": "GET", +"id": "beyondcorp.projects.locations.securityGateways.applications.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName \"test-application\" For more information, please refer to https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous ListHubsRequest, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/applications", +"response": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"hubs": { +"methods": { +"delete": { +"description": "Deletes a single Hub.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}", +"httpMethod": "DELETE", +"id": "beyondcorp.projects.locations.securityGateways.hubs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Hub.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}", +"httpMethod": "GET", +"id": "beyondcorp.projects.locations.securityGateways.hubs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Hub using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/hubs/{hub_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Hubs in a given project and location.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs", +"httpMethod": "GET", +"id": "beyondcorp.projects.locations.securityGateways.hubs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName \"test-hub\" For more information, please refer to https://google.aip.dev/160.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous ListHubsRequest, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/hubs", +"response": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20240807", +"rootUrl": "https://beyondcorp.googleapis.com/", +"schemas": { +"AllocatedConnection": { +"description": "Allocated connection of the AppGateway.", +"id": "AllocatedConnection", +"properties": { +"ingressPort": { +"description": "Required. The ingress port of an allocated connection", +"format": "int32", +"type": "integer" +}, +"pscUri": { +"description": "Required. The PSC uri of an allocated connection", +"type": "string" +} +}, +"type": "object" }, "AppGateway": { "description": "A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppGateway. Multiple connectors can be authorised for a single AppGateway.", @@ -6357,6 +6823,197 @@ }, "type": "object" }, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication": { +"description": "A Beyondcorp Application resource information.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication", +"properties": { +"applicationMatchFilter": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter", +"description": "Required. Application filter conditions associated with an application." +}, +"createTime": { +"description": "Output only. Timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource.", +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the resource was last modified.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter": { +"description": "Match Criteria for Application Filtering.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter", +"properties": { +"matchConditions": { +"description": "Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - (\"*.abc.com\"), (\"xyz.abc.com\") FQDN and PORTS - (\"abc.com\" and \"22\"), (\"abc.com\" and \"22,33)\" etc IP_ADDRESS - (\"10.20.30.40\"), (\"100.20.30.40\") IP_ADDRESS and PORTS - (\"10.20.30.40\" and \"4\"), (\"10.20.30.40\" and \"4,5\")", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition": { +"description": "Match condition for idenfying the application.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition", +"properties": { +"fqdn": { +"description": "Optional. FQDN of the application.", +"type": "string" +}, +"ipAddress": { +"description": "Optional. IP Address of the application.", +"type": "string" +}, +"ports": { +"description": "Optional. Ports of the application.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub": { +"description": "A Beyondcorp Hub resource information.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub", +"properties": { +"createTime": { +"description": "Output only. Timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource.", +"type": "string" +}, +"natGatewayConfig": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig", +"description": "Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits." +}, +"state": { +"description": "Output only. The operational state of the Hub.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"UPDATING", +"DELETING", +"RUNNING", +"DOWN", +"ERROR" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Hub is being created.", +"Hub is being updated.", +"Hub is being deleted.", +"Hub is running.", +"Hub is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.", +"Hub encountered an error and is in an indeterministic state." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the resource was last modified.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig": { +"description": "Represents the NAT Gateway configuration.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig", +"properties": { +"enableNatGateway": { +"description": "Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.", +"type": "boolean" +}, +"natIps": { +"description": "Output only. List of NAT IPs that will be used for establishing connection to the endpoints.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse": { +"description": "Message for response to listing Applications.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse", +"properties": { +"applications": { +"description": "A list of BeyondCorp Application in the project.", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "A list of locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse": { +"description": "Message for response to listing Hubs.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse", +"properties": { +"hubs": { +"description": "A list of BeyondCorp Hub in the project.", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "A list of locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse": { "description": "Message for response to listing SecurityGateways.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse", diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 996772e9d4b..abb0e60806a 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1935,7 +1935,7 @@ } } }, -"revision": "20240727", +"revision": "20240803", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3076,6 +3076,17 @@ }, "type": "object" }, +"DataPolicyOption": { +"description": "Data policy option proto, it currently supports name only, will support precedence later.", +"id": "DataPolicyOption", +"properties": { +"name": { +"description": "Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.", +"type": "string" +} +}, +"type": "object" +}, "DataSplitResult": { "description": "Data split result. This contains references to the training and evaluation data tables that were used to train the model.", "id": "DataSplitResult", @@ -4574,35 +4585,6 @@ }, "type": "object" }, -"IdentityColumnInfo": { -"description": "Metadata for value generation for an identity column.", -"id": "IdentityColumnInfo", -"properties": { -"generatedMode": { -"description": "Optional. Dictates when system generated values are used to populate the field.", -"enum": [ -"GENERATED_MODE_UNSPECIFIED", -"GENERATED_ALWAYS", -"GENERATED_BY_DEFAULT" -], -"enumDescriptions": [ -"Unspecified GeneratedMode will default to GENERATED_ALWAYS.", -"Field can only have system generated values. Users cannot manually insert values into the field.", -"Use system generated values only if the user does not explicitly provide a value." -], -"type": "string" -}, -"increment": { -"description": "Optional. The minimum difference between two successive generated values. Should be INTEGER compatible. Can be negative or positive but not 0. The default value is 1 if the field is not specified.", -"type": "string" -}, -"start": { -"description": "Optional. The first generated value. Should be INTEGER compatible. The default value is 1 if the field is not specified.", -"type": "string" -} -}, -"type": "object" -}, "IndexUnusedReason": { "description": "Reason about why no search index was used in the search query (or sub-query).", "id": "IndexUnusedReason", @@ -8839,6 +8821,13 @@ "description": "Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.", "type": "string" }, +"dataPolicies": { +"description": "Optional. Data policy options, will replace the data_policies.", +"items": { +"$ref": "DataPolicyOption" +}, +"type": "array" +}, "defaultValueExpression": { "description": "Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.", "type": "string" @@ -8858,10 +8847,6 @@ "description": "Optional. Definition of the foreign data type. Only valid for top-level schema fields (not nested fields). If the type is FOREIGN, this field is required.", "type": "string" }, -"identityColumnInfo": { -"$ref": "IdentityColumnInfo", -"description": "Optional. Definition of how values are generated for the field. Setting this option means that the field is an identity column. Only valid for top-level schema INTEGER fields (not nested fields)." -}, "maxLength": { "description": "Optional. Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = \"STRING\", then max_length represents the maximum UTF-8 length of strings in this field. If type = \"BYTES\", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type \u2260 \"STRING\" and \u2260 \"BYTES\".", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 6a71aeda4fb..d4fe77b6c26 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -2194,7 +2194,7 @@ } } }, -"revision": "20240720", +"revision": "20240806", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2375,6 +2375,20 @@ "description": "A backup of a Cloud Bigtable table.", "id": "Backup", "properties": { +"backupType": { +"description": "Indicates the backup type of the backup.", +"enum": [ +"BACKUP_TYPE_UNSPECIFIED", +"STANDARD", +"HOT" +], +"enumDescriptions": [ +"Not specified.", +"The default type for Cloud Bigtable managed backups. Supported for backups created in both HDD and SSD instances. Requires optimization when restored to a table in an SSD instance.", +"A backup type with faster restore to SSD performance. Only supported for backups created in SSD instances. A new SSD table restored from a hot backup reaches production performance more quickly than a standard backup." +], +"type": "string" +}, "encryptionInfo": { "$ref": "EncryptionInfo", "description": "Output only. The encryption information for the backup.", @@ -2387,7 +2401,12 @@ "type": "string" }, "expireTime": { -"description": "Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup.", +"description": "Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.", +"format": "google-datetime", +"type": "string" +}, +"hotToStandardTime": { +"description": "The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.", "format": "google-datetime", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index b1b21c7e379..77fc6e1ee94 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1241,7 +1241,7 @@ } } }, -"revision": "20240804", +"revision": "20240813", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1862,7 +1862,7 @@ "description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." }, "configCompleteRedirectUrl": { -"description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", +"description": "For `MESSAGE` interaction events, the URL that users must be redirected to after they complete an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", "type": "string" }, "dialogEventType": { @@ -2227,8 +2227,8 @@ ], "enumDescriptions": [ "Don't use. Unspecified.", -"Default option. Render a solid divider between sections.", -"If set, no divider is rendered between sections." +"Default option. Render a solid divider.", +"If set, no divider is rendered. This style completely removes the divider from the layout. The result is equivalent to not adding a divider at all." ], "type": "string" }, @@ -4422,7 +4422,7 @@ "id": "Thread", "properties": { "name": { -"description": "Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`", +"description": "Resource name of the thread. Example: `spaces/{space}/threads/{thread}`", "type": "string" }, "threadKey": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 23cdd404d0d..f3646a41c1c 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -1104,7 +1104,7 @@ "type": "string" }, "readMask": { -"description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report ", +"description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report - user_device.app_report ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1151,7 +1151,7 @@ "type": "string" }, "readMask": { -"description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report ", +"description": "Read mask to specify which fields to return. Supported read_mask paths are: - name - org_unit_id - user_id - user_email - user_device.device_id - user_device.audio_status_report - user_device.device_activity_report - user_device.network_bandwidth_report - user_device.peripherals_report - user_device.app_report ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1172,7 +1172,7 @@ } } }, -"revision": "20240709", +"revision": "20240815", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index 4f68c660369..6298ac932e8 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2065,7 +2065,7 @@ } } }, -"revision": "20240728", +"revision": "20240809", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -4602,7 +4602,7 @@ true "type": "string" }, "destinationTargetId": { -"description": "Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * \"@next\", the next target in the promotion sequence.", +"description": "Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * \"@next\", the next target in the promotion sequence", "type": "string" }, "id": { @@ -5995,7 +5995,7 @@ true "id": "TargetAttribute", "properties": { "id": { -"description": "ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * \"*\", all targets in a location.", +"description": "ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * \"*\", all targets in a location", "type": "string" }, "labels": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index 0137cbc254a..a65dc9d4b9a 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -779,7 +779,7 @@ } } }, -"revision": "20240621", +"revision": "20240808", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { @@ -1164,11 +1164,11 @@ }, "oauthToken": { "$ref": "OAuthToken", -"description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com." +"description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override." }, "oidcToken": { "$ref": "OidcToken", -"description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself." +"description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override." }, "uriOverride": { "$ref": "UriOverride", diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index 7e990f29d55..8a3d9cd1209 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -935,7 +935,7 @@ } } }, -"revision": "20240621", +"revision": "20240808", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { @@ -1369,11 +1369,11 @@ }, "oauthToken": { "$ref": "OAuthToken", -"description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com." +"description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as an `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override." }, "oidcToken": { "$ref": "OidcToken", -"description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself." +"description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override." }, "uriOverride": { "$ref": "UriOverride", diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index 097e7045e86..4d9b982219d 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -791,7 +791,7 @@ } } }, -"revision": "20240621", +"revision": "20240808", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -1187,11 +1187,11 @@ }, "oauthToken": { "$ref": "OAuthToken", -"description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com." +"description": "If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override." }, "oidcToken": { "$ref": "OidcToken", -"description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself." +"description": "If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override." }, "uriOverride": { "$ref": "UriOverride", diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 6fc594b1dcb..e7e58490cf7 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -29159,204 +29159,6 @@ } } }, -"regionMultiMigs": { -"methods": { -"delete": { -"description": "Deletes a regional multiMIG in the specified project.", -"flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}", -"httpMethod": "DELETE", -"id": "compute.regionMultiMigs.delete", -"parameterOrder": [ -"project", -"region", -"multiMig" -], -"parameters": { -"multiMig": { -"description": "Name of the multiMIG to delete.", -"location": "path", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/multiMigs/{multiMig}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"get": { -"description": "Returns the specified MultiMIG resource.", -"flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}", -"httpMethod": "GET", -"id": "compute.regionMultiMigs.get", -"parameterOrder": [ -"project", -"region", -"multiMig" -], -"parameters": { -"multiMig": { -"description": "Name of the MultiMig resource to return.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/multiMigs/{multiMig}", -"response": { -"$ref": "MultiMig" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"insert": { -"description": "Creates a regional multiMIG in the specified project.", -"flatPath": "projects/{project}/regions/{region}/multiMigs", -"httpMethod": "POST", -"id": "compute.regionMultiMigs.insert", -"parameterOrder": [ -"project", -"region" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/multiMigs", -"request": { -"$ref": "MultiMig" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"list": { -"description": "Retrieves a list of MultiMIGs in a project and region.", -"flatPath": "projects/{project}/regions/{region}/multiMigs", -"httpMethod": "GET", -"id": "compute.regionMultiMigs.list", -"parameterOrder": [ -"project", -"region" -], -"parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -} -}, -"path": "projects/{project}/regions/{region}/multiMigs", -"response": { -"$ref": "MultiMigsList" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -} -} -}, "regionNetworkEndpointGroups": { "methods": { "attachNetworkEndpoints": { @@ -45278,7 +45080,7 @@ } } }, -"revision": "20240730", +"revision": "20240805", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48691,7 +48493,7 @@ false "type": "number" }, "name": { -"description": "Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", +"description": "Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", "type": "string" } }, @@ -55868,7 +55670,6 @@ false }, "timestamp": { "description": "Timestamp when the matching usage was calculated", -"format": "google-datetime", "type": "string" } }, @@ -69832,286 +69633,6 @@ false }, "type": "object" }, -"MultiMig": { -"description": "MultiMIG represents a group of Managed Instance Groups.", -"id": "MultiMig", -"properties": { -"creationTimestamp": { -"description": "[Output Only] Creation timestamp in RFC3339 text format.", -"type": "string" -}, -"description": { -"description": "An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", -"format": "uint64", -"type": "string" -}, -"kind": { -"default": "compute#multiMig", -"description": "[Output Only] Type of the resource. Always compute#multiMig for MultiMIGs.", -"type": "string" -}, -"locationPolicy": { -"$ref": "MultiMigLocationPolicy" -}, -"name": { -"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"parts": { -"additionalProperties": { -"$ref": "MultiMigPart" -}, -"description": "User-provided names for Parts of MultiMIG and the Parts themselves.", -"type": "object" -}, -"region": { -"description": "[Output Only] URL of the region where the resource resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", -"type": "string" -}, -"schedulingPolicy": { -"$ref": "MultiMigSchedulingPolicy", -"description": "Policy for handling provisioning and other scheduling-related events." -}, -"selfLink": { -"description": "[Output only] Server-defined URL for the resource.", -"type": "string" -}, -"selfLinkWithId": { -"description": "[Output Only] Server-defined URL for this resource with the resource id.", -"type": "string" -}, -"status": { -"$ref": "MultiMigStatus" -} -}, -"type": "object" -}, -"MultiMigLocationPolicy": { -"description": "Policy regarding where to create MIGs Initially only zonal MIGs in the same zone are supported.", -"id": "MultiMigLocationPolicy", -"properties": { -"provisioningZones": { -"description": "List of zones where MIGs will be provisioned. Should be valid RFC1035 name", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"MultiMigPart": { -"description": "Config for an MMIG part.", -"id": "MultiMigPart", -"properties": { -"instanceGroupManager": { -"description": "Link to an existing InstanceGroupManager that will be adopted by a MultiMIG.", -"type": "string" -}, -"instanceGroupManagerProperties": { -"$ref": "InstanceGroupManager", -"description": "InstanceGroupManager to be created by the multiMig" -} -}, -"type": "object" -}, -"MultiMigSchedulingPolicy": { -"description": "Policy for handling provisioning and other scheduling-related events.", -"id": "MultiMigSchedulingPolicy", -"properties": { -"provisioning": { -"description": "How provisioning of MIGs should be scheduled (coordinated or not)", -"enum": [ -"ANY", -"COOORDINATED" -], -"enumDescriptions": [ -"Allows idependent lifecycles of parts.", -"Requires all parts at the same time." -], -"type": "string" -} -}, -"type": "object" -}, -"MultiMigStatus": { -"id": "MultiMigStatus", -"properties": { -"memberInstanceGroupManagers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"MultiMigsList": { -"id": "MultiMigsList", -"properties": { -"etag": { -"type": "string" -}, -"id": { -"description": "Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of MultiMig resources.", -"items": { -"$ref": "MultiMig" -}, -"type": "array" -}, -"kind": { -"default": "compute#multiMigList", -"description": "Type of resource.", -"type": "string" -}, -"nextPageToken": { -"description": "This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output only] Server-defined URL for this resource.", -"type": "string" -}, -"unreachables": { -"description": "[Output only] Unreachable resources.", -"items": { -"type": "string" -}, -"type": "array" -}, -"warning": { -"description": "Informational warning message.", -"properties": { -"code": { -"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", -"enum": [ -"CLEANUP_FAILED", -"DEPRECATED_RESOURCE_USED", -"DEPRECATED_TYPE_USED", -"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", -"EXPERIMENTAL_TYPE_USED", -"EXTERNAL_API_WARNING", -"FIELD_VALUE_OVERRIDEN", -"INJECTED_KERNELS_DEPRECATED", -"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", -"LARGE_DEPLOYMENT_WARNING", -"LIST_OVERHEAD_QUOTA_EXCEED", -"MISSING_TYPE_DEPENDENCY", -"NEXT_HOP_ADDRESS_NOT_ASSIGNED", -"NEXT_HOP_CANNOT_IP_FORWARD", -"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", -"NEXT_HOP_INSTANCE_NOT_FOUND", -"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", -"NEXT_HOP_NOT_RUNNING", -"NOT_CRITICAL_ERROR", -"NO_RESULTS_ON_PAGE", -"PARTIAL_SUCCESS", -"REQUIRED_TOS_AGREEMENT", -"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", -"RESOURCE_NOT_DELETED", -"SCHEMA_VALIDATION_IGNORED", -"SINGLE_INSTANCE_PROPERTY_TEMPLATE", -"UNDECLARED_PROPERTIES", -"UNREACHABLE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"Warning about failed cleanup of transient changes made by a failed operation.", -"A link to a deprecated resource was created.", -"When deploying and at least one of the resources has a type marked as deprecated", -"The user created a boot disk that is larger than image size.", -"When deploying and at least one of the resources has a type marked as experimental", -"Warning that is present in an external api call", -"Warning that value of a field has been overridden. Deprecated unused field.", -"The operation involved use of an injected kernel, which is deprecated.", -"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", -"When deploying a deployment with a exceedingly large number of resources", -"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", -"A resource depends on a missing type", -"The route's nextHopIp address is not assigned to an instance on the network.", -"The route's next hop instance cannot ip forward.", -"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", -"The route's nextHopInstance URL refers to an instance that does not exist.", -"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", -"The route's next hop instance does not have a status of RUNNING.", -"Error which is not critical. We decided to continue the process despite the mentioned error.", -"No results are present on a particular list page.", -"Success is reported, but some results may be missing due to errors", -"The user attempted to use a resource that requires a TOS they have not accepted.", -"Warning that a resource is in use.", -"One or more of the resources set to auto-delete could not be deleted because they were in use.", -"When a resource schema validation is ignored.", -"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", -"When undeclared properties in the schema are present", -"A given scope cannot be reached." -], -"type": "string" -}, -"data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", -"items": { -"properties": { -"key": { -"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", -"type": "string" -}, -"value": { -"description": "[Output Only] A warning data value corresponding to the key.", -"type": "string" -} -}, -"type": "object" -}, -"type": "array" -}, -"message": { -"description": "[Output Only] A human-readable description of the warning code.", -"type": "string" -} -}, -"type": "object" -} -}, -"type": "object" -}, "MutualTls": { "description": "[Deprecated] Configuration for the mutual Tls mode for peer authentication. Configuration for the mutual Tls mode for peer authentication.", "id": "MutualTls", @@ -100807,7 +100328,7 @@ false "type": "object" }, "localTrafficSelector": { -"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.", +"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -100837,7 +100358,7 @@ false "type": "string" }, "peerIp": { -"description": "IP address of the peer VPN gateway. Only IPv4 is supported.", +"description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.", "type": "string" }, "region": { @@ -100845,7 +100366,7 @@ false "type": "string" }, "remoteTrafficSelector": { -"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.", +"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -100902,7 +100423,7 @@ false "type": "string" }, "targetVpnGateway": { -"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", +"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.", "type": "string" }, "vpnGateway": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 91d4caee319..84e6a658a7d 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -41911,7 +41911,7 @@ } } }, -"revision": "20240730", +"revision": "20240813", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45076,6 +45076,25 @@ false "description": "If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.", "type": "boolean" }, +"externalManagedMigrationState": { +"description": "Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.", +"enum": [ +"PREPARE", +"TEST_ALL_TRAFFIC", +"TEST_BY_PERCENTAGE" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"externalManagedMigrationTestingPercentage": { +"description": "Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.", +"format": "float", +"type": "number" +}, "failoverPolicy": { "$ref": "BackendServiceFailoverPolicy", "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview)." @@ -50764,6 +50783,25 @@ false "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, +"externalManagedBackendBucketMigrationState": { +"description": "Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.", +"enum": [ +"PREPARE", +"TEST_ALL_TRAFFIC", +"TEST_BY_PERCENTAGE" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +}, +"externalManagedBackendBucketMigrationTestingPercentage": { +"description": "Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.", +"format": "float", +"type": "number" +}, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.", "format": "byte", @@ -51492,10 +51530,6 @@ false "$ref": "ShareSettings", "description": "List of Projects/Folders to share with." }, -"specificReservationRequired": { -"description": "Indicates whether the auto-created reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation.", -"type": "boolean" -}, "specificSkuProperties": { "$ref": "FutureReservationSpecificSKUProperties", "description": "Future Reservation configuration to indicate instance properties and total count." @@ -51629,7 +51663,6 @@ false }, "timestamp": { "description": "Timestamp when the matching usage was calculated", -"format": "google-datetime", "type": "string" } }, @@ -63080,6 +63113,20 @@ false }, "type": "array" }, +"architecture": { +"description": "[Output Only] The architecture of the machine type.", +"enum": [ +"ARCHITECTURE_UNSPECIFIED", +"ARM64", +"X86_64" +], +"enumDescriptions": [ +"Default value indicating Architecture is not set.", +"Machines with architecture ARM64", +"Machines with architecture X86_64" +], +"type": "string" +}, "bundledLocalSsds": { "$ref": "BundledLocalSsds", "description": "[Output Only] The configuration of bundled local SSD for the machine type." @@ -90769,7 +90816,7 @@ false "type": "object" }, "localTrafficSelector": { -"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.", +"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -90799,7 +90846,7 @@ false "type": "string" }, "peerIp": { -"description": "IP address of the peer VPN gateway. Only IPv4 is supported.", +"description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.", "type": "string" }, "region": { @@ -90807,7 +90854,7 @@ false "type": "string" }, "remoteTrafficSelector": { -"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.", +"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -90864,7 +90911,7 @@ false "type": "string" }, "targetVpnGateway": { -"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", +"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.", "type": "string" }, "vpnGateway": { diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index a1646d01ffd..e43e0b4be01 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -37779,7 +37779,7 @@ } } }, -"revision": "20240730", +"revision": "20240813", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47048,10 +47048,6 @@ false "$ref": "ShareSettings", "description": "List of Projects/Folders to share with." }, -"specificReservationRequired": { -"description": "Indicates whether the auto-created reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation.", -"type": "boolean" -}, "specificSkuProperties": { "$ref": "FutureReservationSpecificSKUProperties", "description": "Future Reservation configuration to indicate instance properties and total count." @@ -47185,7 +47181,6 @@ false }, "timestamp": { "description": "Timestamp when the matching usage was calculated", -"format": "google-datetime", "type": "string" } }, @@ -58195,6 +58190,20 @@ false }, "type": "array" }, +"architecture": { +"description": "[Output Only] The architecture of the machine type.", +"enum": [ +"ARCHITECTURE_UNSPECIFIED", +"ARM64", +"X86_64" +], +"enumDescriptions": [ +"Default value indicating Architecture is not set.", +"Machines with architecture ARM64", +"Machines with architecture X86_64" +], +"type": "string" +}, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -84498,7 +84507,7 @@ false "type": "object" }, "localTrafficSelector": { -"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.", +"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -84528,7 +84537,7 @@ false "type": "string" }, "peerIp": { -"description": "IP address of the peer VPN gateway. Only IPv4 is supported.", +"description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.", "type": "string" }, "region": { @@ -84536,7 +84545,7 @@ false "type": "string" }, "remoteTrafficSelector": { -"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.", +"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -84593,7 +84602,7 @@ false "type": "string" }, "targetVpnGateway": { -"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", +"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.", "type": "string" }, "vpnGateway": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index c51e62418b2..010928f96bb 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2427,7 +2427,7 @@ } } }, -"revision": "20240729", +"revision": "20240811", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2582,6 +2582,10 @@ "displayName": { "description": "Display name for authentication template.", "type": "string" +}, +"isDefault": { +"description": "Whether the auth config is the default one.", +"type": "boolean" } }, "type": "object" @@ -2925,6 +2929,11 @@ "description": "Output only. Eventing Runtime Data.", "readOnly": true }, +"host": { +"description": "Output only. The name of the Hostname of the Service Directory service with TLS.", +"readOnly": true, +"type": "string" +}, "imageLocation": { "description": "Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "readOnly": true, @@ -2996,6 +3005,11 @@ "description": "Optional. Suspended indicates if a user has suspended a connection or not.", "type": "boolean" }, +"tlsServiceDirectory": { +"description": "Output only. The name of the Service Directory service with TLS.", +"readOnly": true, +"type": "string" +}, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", @@ -3344,6 +3358,11 @@ "description": "Output only. Eventing configuration supported by the Connector.", "readOnly": true }, +"isAsyncOperationsSupported": { +"description": "Output only. Is async operations supported.", +"readOnly": true, +"type": "boolean" +}, "isCustomActionsSupported": { "description": "Output only. Is custom actions supported.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 9e766acebaa..b18e6dac370 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, -"revision": "20240722", +"revision": "20240730", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3394,6 +3394,10 @@ "readOnly": true, "type": "boolean" }, +"secretManagerConfig": { +"$ref": "SecretManagerConfig", +"description": "Secret CSI driver configuration." +}, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture API features for the cluster." @@ -3760,6 +3764,10 @@ "$ref": "ResourceUsageExportConfig", "description": "The desired configuration for exporting resource usage." }, +"desiredSecretManagerConfig": { +"$ref": "SecretManagerConfig", +"description": "Enable/Disable Secret Manager Config." +}, "desiredSecurityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture API features for the cluster." @@ -5482,6 +5490,13 @@ false "description": "Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.", "type": "boolean" }, +"storagePools": { +"description": "List of Storage Pools where boot disks are provisioned.", +"items": { +"type": "string" +}, +"type": "array" +}, "tags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.", "items": { @@ -6621,6 +6636,17 @@ false "properties": {}, "type": "object" }, +"SecretManagerConfig": { +"description": "SecretManagerConfig is config for secret manager enablement.", +"id": "SecretManagerConfig", +"properties": { +"enabled": { +"description": "Enable/Disable Secret Manager Config.", +"type": "boolean" +} +}, +"type": "object" +}, "SecurityBulletinEvent": { "description": "SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.", "id": "SecurityBulletinEvent", @@ -7581,6 +7607,13 @@ false "$ref": "ResourceManagerTags", "description": "Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values." }, +"storagePools": { +"description": "List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.", +"items": { +"type": "string" +}, +"type": "array" +}, "tags": { "$ref": "NetworkTags", "description": "The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags." diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index eeddd27ca45..350ed9f0b53 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2565,7 +2565,7 @@ } } }, -"revision": "20240722", +"revision": "20240730", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5930,6 +5930,13 @@ false "description": "Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.", "type": "boolean" }, +"storagePools": { +"description": "List of Storage Pools where boot disks are provisioned.", +"items": { +"type": "string" +}, +"type": "array" +}, "tags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.", "items": { @@ -7160,7 +7167,7 @@ false "id": "SecretManagerConfig", "properties": { "enabled": { -"description": "Whether the cluster is configured to use secret manager CSI component.", +"description": "Enable/Disable Secret Manager Config.", "type": "boolean" } }, @@ -8152,6 +8159,13 @@ false "$ref": "ResourceManagerTags", "description": "Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values." }, +"storagePools": { +"description": "List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.", +"items": { +"type": "string" +}, +"type": "array" +}, "tags": { "$ref": "NetworkTags", "description": "The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags." diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index ef063dbb320..2ec817ed1b4 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -86,6 +86,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataflow.us-west4.rep.googleapis.com/", "location": "us-west4" }, @@ -1852,7 +1857,7 @@ "templates": { "methods": { "create": { -"description": "Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.", +"description": "Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`.", "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates", "httpMethod": "POST", "id": "dataflow.projects.locations.templates.create", @@ -1887,7 +1892,7 @@ ] }, "get": { -"description": "Get the template associated with a template.", +"description": "Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.", "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get", "httpMethod": "GET", "id": "dataflow.projects.locations.templates.get", @@ -1935,7 +1940,7 @@ ] }, "launch": { -"description": "Launch a template.", +"description": "Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.", "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch", "httpMethod": "POST", "id": "dataflow.projects.locations.templates.launch", @@ -2072,7 +2077,7 @@ "templates": { "methods": { "create": { -"description": "Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.", +"description": "Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. To create a job, we recommend using `projects.locations.templates.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.create` is not recommended, because your job will always start in `us-central1`.", "flatPath": "v1b3/projects/{projectId}/templates", "httpMethod": "POST", "id": "dataflow.projects.templates.create", @@ -2100,7 +2105,7 @@ ] }, "get": { -"description": "Get the template associated with a template.", +"description": "Get the template associated with a template. To get the template, we recommend using `projects.locations.templates.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.get` is not recommended, because only templates that are running in `us-central1` are retrieved.", "flatPath": "v1b3/projects/{projectId}/templates:get", "httpMethod": "GET", "id": "dataflow.projects.templates.get", @@ -2146,7 +2151,7 @@ ] }, "launch": { -"description": "Launch a template.", +"description": "Launches a template. To launch a template, we recommend using `projects.locations.templates.launch` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.templates.launch` is not recommended, because jobs launched from the template will always start in `us-central1`.", "flatPath": "v1b3/projects/{projectId}/templates:launch", "httpMethod": "POST", "id": "dataflow.projects.templates.launch", @@ -2203,7 +2208,7 @@ } } }, -"revision": "20240709", +"revision": "20240807", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { @@ -4413,6 +4418,11 @@ "description": "The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.", "type": "string" }, +"projectNumber": { +"description": "Optional. The project number of the project this worker belongs to.", +"format": "int64", +"type": "string" +}, "requestedLeaseDuration": { "description": "The initial lease period.", "format": "google-duration", @@ -5375,6 +5385,11 @@ false "description": "The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the WorkItem's job.", "type": "string" }, +"projectNumber": { +"description": "Optional. The project number of the project which owns the WorkItem's job.", +"format": "int64", +"type": "string" +}, "unifiedWorkerRequest": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 18d4476d425..e9ec0a09c62 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -1760,6 +1760,99 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"objects": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:getIamPolicy", +"httpMethod": "GET", +"id": "datamigration.projects.locations.migrationJobs.objects.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:setIamPolicy", +"httpMethod": "POST", +"id": "datamigration.projects.locations.migrationJobs.objects.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:testIamPermissions", +"httpMethod": "POST", +"id": "datamigration.projects.locations.migrationJobs.objects.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "operations": { @@ -2125,7 +2218,7 @@ } } }, -"revision": "20240721", +"revision": "20240812", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2532,6 +2625,7 @@ "MYSQL_8_0_35", "MYSQL_8_0_36", "MYSQL_8_0_37", +"MYSQL_8_4", "POSTGRES_9_6", "POSTGRES_11", "POSTGRES_10", @@ -2558,6 +2652,7 @@ "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", "The database major version is MySQL 8.0 and the minor version is 37.", +"MySQL 8.4.", "PostgreSQL 9.6.", "PostgreSQL 11.", "PostgreSQL 10.", @@ -4820,6 +4915,43 @@ }, "type": "object" }, +"OracleAsmConfig": { +"description": "Configuration for Oracle Automatic Storage Management (ASM) connection.", +"id": "OracleAsmConfig", +"properties": { +"asmService": { +"description": "Required. ASM service name for the Oracle ASM connection.", +"type": "string" +}, +"hostname": { +"description": "Required. Hostname for the Oracle ASM connection.", +"type": "string" +}, +"password": { +"description": "Required. Input only. Password for the Oracle ASM connection.", +"type": "string" +}, +"passwordSet": { +"description": "Output only. Indicates whether a new password is included in the request.", +"readOnly": true, +"type": "boolean" +}, +"port": { +"description": "Required. Port for the Oracle ASM connection.", +"format": "int32", +"type": "integer" +}, +"ssl": { +"$ref": "SslConfig", +"description": "Optional. SSL configuration for the Oracle connection." +}, +"username": { +"description": "Required. Username for the Oracle ASM connection.", +"type": "string" +} +}, +"type": "object" +}, "OracleConnectionProfile": { "description": "Specifies connection parameters required specifically for Oracle databases.", "id": "OracleConnectionProfile", @@ -4836,6 +4968,10 @@ "description": "Required. The IP or hostname of the source Oracle database.", "type": "string" }, +"oracleAsmConfig": { +"$ref": "OracleAsmConfig", +"description": "Optional. Configuration for Oracle ASM connection." +}, "password": { "description": "Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 06f59653b7c..81263fe0deb 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8714,7 +8714,7 @@ } } }, -"revision": "20240724", +"revision": "20240812", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9018,17 +9018,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", @@ -9067,17 +9056,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3DeployFlowMetadata", @@ -9544,55 +9522,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata", @@ -10144,17 +10073,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3ResponseMessage", @@ -10362,7 +10280,7 @@ "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -10719,17 +10637,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3Webhook": { "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "id": "GoogleCloudDialogflowCxV3Webhook", @@ -11416,17 +11323,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", @@ -11465,17 +11361,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata", @@ -11942,55 +11827,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata", @@ -12546,17 +12382,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", @@ -12752,7 +12577,7 @@ "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -13170,17 +12995,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1Webhook": { "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "id": "GoogleCloudDialogflowCxV3beta1Webhook", @@ -18415,7 +18229,7 @@ true "description": "Required. The natural language text query for knowledge search." }, "sessionId": { -"description": "Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", +"description": "Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", "type": "string" } }, @@ -21668,7 +21482,7 @@ true "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", "properties": { "text": { -"description": "A collection of text responses.", +"description": "A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -22058,88 +21872,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV3alpha1TurnSignals": { "description": "Collection of all signals that were extracted for a single turn of the conversation.", "id": "GoogleCloudDialogflowV3alpha1TurnSignals", @@ -22209,17 +21941,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index b0d2f1d7138..15ae48abdbb 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8082,7 +8082,7 @@ } } }, -"revision": "20240724", +"revision": "20240812", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8386,17 +8386,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", @@ -8435,17 +8424,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3DeployFlowMetadata", @@ -8912,55 +8890,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata", @@ -9512,17 +9441,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3ResponseMessage", @@ -9730,7 +9648,7 @@ "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -10087,17 +10005,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3Webhook": { "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "id": "GoogleCloudDialogflowCxV3Webhook", @@ -10784,17 +10691,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", @@ -10833,17 +10729,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata", @@ -11310,55 +11195,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata", @@ -11914,17 +11750,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", @@ -12120,7 +11945,7 @@ "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -12538,17 +12363,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1Webhook": { "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "id": "GoogleCloudDialogflowCxV3beta1Webhook", @@ -20175,7 +19989,7 @@ true "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", "properties": { "text": { -"description": "A collection of text responses.", +"description": "A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -20300,7 +20114,7 @@ true "description": "Required. The natural language text query for knowledge search." }, "sessionId": { -"description": "Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", +"description": "Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.", "type": "string" } }, @@ -21534,88 +21348,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV3alpha1TurnSignals": { "description": "Collection of all signals that were extracted for a single turn of the conversation.", "id": "GoogleCloudDialogflowV3alpha1TurnSignals", @@ -21685,17 +21417,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 876d39e7b3b..adba232caeb 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240724", +"revision": "20240812", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4906,6 +4906,10 @@ "format": "float", "type": "number" }, +"boostControlSpec": { +"$ref": "GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec", +"description": "Optional. Complex specification for custom ranking based on customer defined attribute value." +}, "condition": { "description": "Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))", "type": "string" @@ -4913,6 +4917,66 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec": { +"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": "GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "Optional. The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "Optional. 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" +}, +"GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"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": "GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3BoostSpecs": { "description": "Boost specifications for data stores.", "id": "GoogleCloudDialogflowCxV3BoostSpecs", @@ -5172,17 +5236,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", @@ -5447,17 +5500,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3DeployFlowMetadata", @@ -6882,55 +6924,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata", @@ -8410,17 +8403,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ResourceName": { "description": "Resource name and display name.", "id": "GoogleCloudDialogflowCxV3ResourceName", @@ -8643,7 +8625,7 @@ false "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -9603,17 +9585,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ValidateAgentRequest": { "description": "The request message for Agents.ValidateAgent.", "id": "GoogleCloudDialogflowCxV3ValidateAgentRequest", @@ -10526,17 +10497,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", @@ -10575,17 +10535,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata", @@ -11052,55 +11001,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata", @@ -11656,17 +11556,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3beta1ResponseMessage", @@ -11862,7 +11751,7 @@ false "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -12280,17 +12169,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1Webhook": { "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "id": "GoogleCloudDialogflowCxV3beta1Webhook", @@ -17160,7 +17038,7 @@ true "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", "properties": { "text": { -"description": "A collection of text responses.", +"description": "A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -17550,88 +17428,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV3alpha1TurnSignals": { "description": "Collection of all signals that were extracted for a single turn of the conversation.", "id": "GoogleCloudDialogflowV3alpha1TurnSignals", @@ -17701,17 +17497,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 650e797fcfe..949c9a4f998 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240731", +"revision": "20240812", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5489,17 +5489,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3CreateVersionOperationMetadata", @@ -5538,17 +5527,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3DeployFlowMetadata", @@ -6015,55 +5993,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3ImportEntityTypesMetadata", @@ -6615,17 +6544,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3ResponseMessage": { "description": "Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.", "id": "GoogleCloudDialogflowCxV3ResponseMessage", @@ -6833,7 +6751,7 @@ "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -7190,17 +7108,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3Webhook": { "description": "Webhooks host the developer's business logic. During a session, webhooks allow the developer to use the data extracted by Dialogflow's natural language processing to generate dynamic responses, validate collected data, or trigger actions on the backend.", "id": "GoogleCloudDialogflowCxV3Webhook", @@ -8078,6 +7985,10 @@ "format": "float", "type": "number" }, +"boostControlSpec": { +"$ref": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpec", +"description": "Optional. Complex specification for custom ranking based on customer defined attribute value." +}, "condition": { "description": "Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": * (id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\",\"Blue\"))", "type": "string" @@ -8085,6 +7996,66 @@ }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpec": { +"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": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"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": "Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "Optional. The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "Optional. 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" +}, +"GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"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": "GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1BoostSpecs": { "description": "Boost specifications for data stores.", "id": "GoogleCloudDialogflowCxV3beta1BoostSpecs", @@ -8606,17 +8577,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": { "description": "Metadata associated with the long running operation for Versions.CreateVersion.", "id": "GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata", @@ -8881,17 +8841,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata": { "description": "Metadata returned for the Environments.DeployFlow long running operation.", "id": "GoogleCloudDialogflowCxV3beta1DeployFlowMetadata", @@ -10505,55 +10454,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowCxV3beta1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata": { "description": "Metadata returned for the EntityTypes.ImportEntityTypes long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportEntityTypesMetadata", @@ -12483,17 +12383,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1ResourceName": { "description": "Resource name and display name.", "id": "GoogleCloudDialogflowCxV3beta1ResourceName", @@ -12704,7 +12593,7 @@ false "type": "boolean" }, "text": { -"description": "Required. A collection of text responses.", +"description": "Required. A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -13470,6 +13359,10 @@ false "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationApiKeyConfig", "description": "Config for API key auth." }, +"bearerTokenConfig": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig", +"description": "Config for bearer token auth." +}, "oauthConfig": { "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig", "description": "Config for OAuth." @@ -13510,6 +13403,17 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig": { +"description": "Config for authentication using bearer token.", +"id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationBearerTokenConfig", +"properties": { +"token": { +"description": "Required. The text token appended to the text `Bearer` to the request Authorization header. [Session parameters reference](https://cloud.google.com/dialogflow/cx/docs/concept/parameter#session-ref) can be used to pass the token dynamically, e.g. `$session.params.parameter-id`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig": { "description": "Config for authentication with OAuth.", "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig", @@ -13544,7 +13448,22 @@ false "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig": { "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).", "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig", -"properties": {}, +"properties": { +"serviceAgentAuth": { +"description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.", +"enum": [ +"SERVICE_AGENT_AUTH_UNSPECIFIED", +"ID_TOKEN", +"ACCESS_TOKEN" +], +"enumDescriptions": [ +"Service agent auth type unspecified. Default to ID_TOKEN.", +"Use [ID token](https://cloud.google.com/docs/authentication/token-types#id) generated from service agent. This can be used to access Cloud Function and Cloud Run after you grant Invoker role to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`.", +"Use [access token](https://cloud.google.com/docs/authentication/token-types#access) generated from service agent. This can be used to access other Google Cloud APIs after you grant required roles to `service-@gcp-sa-dialogflow.iam.gserviceaccount.com`." +], +"type": "string" +} +}, "type": "object" }, "GoogleCloudDialogflowCxV3beta1ToolCall": { @@ -14043,17 +13962,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowCxV3beta1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowCxV3beta1UserUtterance": { "description": "UserUtterance represents one message sent by the customer.", "id": "GoogleCloudDialogflowCxV3beta1UserUtterance", @@ -19160,7 +19068,7 @@ true "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", "properties": { "text": { -"description": "A collection of text responses.", +"description": "A collection of text response variants. If multiple variants are defined, only one text response variant is returned at runtime.", "items": { "type": "string" }, @@ -19550,88 +19458,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata": { -"description": "Metadata for CreateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1CreateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata": { -"description": "Metadata for DeleteDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1DeleteDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata": { -"description": "Metadata in google::longrunning::Operation for Knowledge operations.", -"id": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"properties": { -"state": { -"description": "Required. Output only. The current state of this operation.", -"enum": [ -"STATE_UNSPECIFIED", -"PENDING", -"RUNNING", -"DONE" -], -"enumDescriptions": [ -"State unspecified.", -"The operation has been created.", -"The operation is currently running.", -"The operation is done, either cancelled or completed." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata": { -"description": "Metadata for ImportDocuments operation.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ImportDocumentsResponse": { -"description": "Response message for Documents.ImportDocuments.", -"id": "GoogleCloudDialogflowV3alpha1ImportDocumentsResponse", -"properties": { -"warnings": { -"description": "Includes details about skipped documents or any other warnings.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata": { -"description": "Metadata for ReloadDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1ReloadDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV3alpha1TurnSignals": { "description": "Collection of all signals that were extracted for a single turn of the conversation.", "id": "GoogleCloudDialogflowV3alpha1TurnSignals", @@ -19701,17 +19527,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata": { -"description": "Metadata for UpdateDocument operation.", -"id": "GoogleCloudDialogflowV3alpha1UpdateDocumentOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudDialogflowV3alpha1GenericKnowledgeOperationMetadata", -"description": "The generic information of the operation." -} -}, -"type": "object" -}, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 32c2804b6b0..62e06827a6e 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -454,10 +454,71 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"trainCustomModel": { +"description": "Trains a custom model.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+dataStore}:trainCustomModel", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { "branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/batchGetDocumentsMetadata", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "documents": { "methods": { @@ -1189,6 +1250,35 @@ } } }, +"customModels": { +"methods": { +"list": { +"description": "Gets a list of all the custom models.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.customModels.list", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+dataStore}/customModels", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "models": { "resources": { "operations": { @@ -3690,6 +3780,39 @@ }, "resources": { "branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/batchGetDocumentsMetadata", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "documents": { "methods": { @@ -5851,7 +5974,7 @@ } } }, -"revision": "20240801", +"revision": "20240813", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6021,7 +6144,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -6045,7 +6168,8 @@ "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -6054,7 +6178,8 @@ "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -6946,6 +7071,63 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse": { +"description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", +"id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse", +"properties": { +"documentsMetadata": { +"description": "The metadata of the Documents.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata": { +"description": "The metadata of a Document.", +"id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata", +"properties": { +"lastRefreshedTime": { +"description": "The timestamp of the last time the Document was last indexed.", +"format": "google-datetime", +"type": "string" +}, +"matcherValue": { +"$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", +"description": "The value of the matcher that was used to match the Document." +}, +"status": { +"description": "The status of the document.", +"enum": [ +"STATUS_UNSPECIFIED", +"STATUS_INDEXED", +"STATUS_NOT_IN_TARGET_SITE", +"STATUS_NOT_IN_INDEX" +], +"enumDescriptions": [ +"Should never be set.", +"The Document is indexed.", +"The Document is not indexed because its URI is not in the TargetSite.", +"The Document is not indexed." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { +"description": "The value of the matcher that was used to match the Document.", +"id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", +"properties": { +"uri": { +"description": "If match by URI, the URI of the Document.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest", @@ -6973,7 +7155,7 @@ "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { -"description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -7124,7 +7306,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -7214,6 +7396,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", "type": "boolean" }, +"score": { +"description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].", +"format": "double", +"type": "number" +}, "startPos": { "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", "format": "int32", @@ -7363,7 +7550,7 @@ "type": "boolean" }, "projectId": { -"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -7524,7 +7711,7 @@ "id": "GoogleCloudDiscoveryengineV1Control", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -7916,6 +8103,67 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1CustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1CustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"displayName": { +"description": "The display name of the model.", +"type": "string" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelState": { +"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"enum": [ +"MODEL_STATE_UNSPECIFIED", +"TRAINING_PAUSED", +"TRAINING", +"TRAINING_COMPLETE", +"READY_FOR_SERVING", +"TRAINING_FAILED", +"NO_IMPROVEMENT" +], +"enumDescriptions": [ +"Default value.", +"The model is in a paused training state.", +"The model is currently training.", +"The model has successfully completed training.", +"The model is ready for serving.", +"The model training failed.", +"The model training finished successfully but metrics did not improve." +], +"type": "string" +}, +"modelVersion": { +"description": "The version of the model.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", +"type": "string" +}, +"trainingStartTime": { +"description": "Timestamp the model training was initiated.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1DataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", @@ -7926,13 +8174,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -7999,6 +8249,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1Schema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -9110,6 +9364,20 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse", +"properties": { +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1CustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1ListDataStoresResponse": { "description": "Response message for DataStoreService.ListDataStores method.", "id": "GoogleCloudDiscoveryengineV1ListDataStoresResponse", @@ -10495,7 +10763,8 @@ "POTENTIAL_POLICY_VIOLATION", "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", @@ -10505,7 +10774,8 @@ "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -10774,7 +11044,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -10926,6 +11196,103 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { +"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", +"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" +}, +"GoogleCloudDiscoveryengineV1TrainCustomModelRequest": { +"description": "Request message for SearchTuningService.TrainCustomModel method.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "The desired location of errors incurred during the data ingestion and training." +}, +"gcsTrainingInput": { +"$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput", +"description": "Cloud Storage training input." +}, +"modelId": { +"description": "If not provided, a UUID will be generated.", +"type": "string" +}, +"modelType": { +"description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput": { +"description": "Cloud Storage training data input.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput", +"properties": { +"corpusDataPath": { +"description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", +"type": "string" +}, +"queryDataPath": { +"description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", +"type": "string" +}, +"testDataPath": { +"description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", +"type": "string" +}, +"trainDataPath": { +"description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the data.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelName": { +"description": "Fully qualified name of the CustomTuningModel.", +"type": "string" +}, +"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" +}, "GoogleCloudDiscoveryengineV1TransactionInfo": { "description": "A transaction represents the entire purchase transaction.", "id": "GoogleCloudDiscoveryengineV1TransactionInfo", @@ -11110,6 +11477,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1WorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", @@ -11139,7 +11537,8 @@ "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -11148,7 +11547,8 @@ "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -11690,7 +12090,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -11986,13 +12386,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -12068,6 +12470,10 @@ "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)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -14678,6 +15084,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -14767,7 +15204,7 @@ "id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -15048,13 +15485,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -15125,6 +15564,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1betaSchema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -16274,6 +16717,24 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", +"enum": [ +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." +], +"type": "string" +}, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" @@ -17070,6 +17531,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index bdb1beadbfb..55efe3e3902 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -246,7 +246,7 @@ ] }, "updateAclConfig": { -"description": "Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", +"description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", "httpMethod": "PATCH", "id": "discoveryengine.projects.locations.updateAclConfig", @@ -681,6 +681,39 @@ }, "resources": { "branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/batchGetDocumentsMetadata", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "documents": { "methods": { @@ -4450,6 +4483,39 @@ }, "resources": { "branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/batchGetDocumentsMetadata", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "documents": { "methods": { @@ -7289,6 +7355,80 @@ ] } } +}, +"userStores": { +"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}/userStores/{userStoresId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userStores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+/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}/userStores/{userStoresId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userStores.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/[^/]+/userStores/[^/]+$", +"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" +] +} +} +} +} } } }, @@ -7365,7 +7505,7 @@ } } }, -"revision": "20240801", +"revision": "20240813", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7789,7 +7929,7 @@ "id": "GoogleCloudDiscoveryengineV1Control", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -8003,13 +8143,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -8076,6 +8218,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1Schema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -9034,6 +9180,57 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { +"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", +"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" +}, +"GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the data.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelName": { +"description": "Fully qualified name of the CustomTuningModel.", +"type": "string" +}, +"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" +}, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", @@ -9068,6 +9265,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1WorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", @@ -9104,7 +9332,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -9128,7 +9356,8 @@ "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -9137,7 +9366,8 @@ "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -10033,6 +10263,63 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse": { +"description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse", +"properties": { +"documentsMetadata": { +"description": "The metadata of the Documents.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata": { +"description": "The metadata of a Document.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata", +"properties": { +"lastRefreshedTime": { +"description": "The timestamp of the last time the Document was last indexed.", +"format": "google-datetime", +"type": "string" +}, +"matcherValue": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", +"description": "The value of the matcher that was used to match the Document." +}, +"status": { +"description": "The status of the document.", +"enum": [ +"STATUS_UNSPECIFIED", +"STATUS_INDEXED", +"STATUS_NOT_IN_TARGET_SITE", +"STATUS_NOT_IN_INDEX" +], +"enumDescriptions": [ +"Should never be set.", +"The Document is indexed.", +"The Document is not indexed because its URI is not in the TargetSite.", +"The Document is not indexed." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { +"description": "The value of the matcher that was used to match the Document.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", +"properties": { +"uri": { +"description": "If match by URI, the URI of the Document.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", @@ -10060,7 +10347,7 @@ "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { -"description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -10211,7 +10498,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -10301,6 +10588,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", "type": "boolean" }, +"score": { +"description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].", +"format": "double", +"type": "number" +}, "startPos": { "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", "format": "int32", @@ -10539,7 +10831,7 @@ "type": "boolean" }, "projectId": { -"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -10700,7 +10992,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -11191,13 +11483,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -11273,6 +11567,10 @@ "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)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -15466,6 +15764,10 @@ "description": "Name of the string field as defined in the schema.", "type": "string" }, +"querySegment": { +"description": "Identifies the keywords within the search query that match a filter.", +"type": "string" +}, "values": { "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", "items": { @@ -15582,7 +15884,8 @@ "POTENTIAL_POLICY_VIOLATION", "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", @@ -15592,7 +15895,8 @@ "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -16084,7 +16388,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -16540,6 +16844,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -16629,7 +16964,7 @@ "id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -16910,13 +17245,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -16987,6 +17324,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1betaSchema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -18136,6 +18477,24 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", +"enum": [ +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." +], +"type": "string" +}, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" @@ -18932,6 +19291,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index c2cc6a196ba..56fd1ddce8a 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -486,6 +486,39 @@ }, "resources": { "branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/batchGetDocumentsMetadata", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "documents": { "methods": { @@ -4021,6 +4054,39 @@ }, "resources": { "branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/batchGetDocumentsMetadata", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "documents": { "methods": { @@ -6708,7 +6774,7 @@ } } }, -"revision": "20240801", +"revision": "20240813", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6946,7 +7012,7 @@ "id": "GoogleCloudDiscoveryengineV1Control", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -7160,13 +7226,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -7233,6 +7301,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1Schema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -8191,6 +8263,57 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { +"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", +"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" +}, +"GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the data.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelName": { +"description": "Fully qualified name of the CustomTuningModel.", +"type": "string" +}, +"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" +}, "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { "description": "Metadata for UpdateSchema LRO.", "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", @@ -8225,6 +8348,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1WorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", @@ -8254,7 +8408,8 @@ "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -8263,7 +8418,8 @@ "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -8805,7 +8961,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -9101,13 +9257,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -9183,6 +9341,10 @@ "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)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -11793,6 +11955,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -11814,7 +12007,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -11838,7 +12031,8 @@ "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -11847,7 +12041,8 @@ "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -12739,6 +12934,63 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse": { +"description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", +"id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse", +"properties": { +"documentsMetadata": { +"description": "The metadata of the Documents.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata": { +"description": "The metadata of a Document.", +"id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata", +"properties": { +"lastRefreshedTime": { +"description": "The timestamp of the last time the Document was last indexed.", +"format": "google-datetime", +"type": "string" +}, +"matcherValue": { +"$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", +"description": "The value of the matcher that was used to match the Document." +}, +"status": { +"description": "The status of the document.", +"enum": [ +"STATUS_UNSPECIFIED", +"STATUS_INDEXED", +"STATUS_NOT_IN_TARGET_SITE", +"STATUS_NOT_IN_INDEX" +], +"enumDescriptions": [ +"Should never be set.", +"The Document is indexed.", +"The Document is not indexed because its URI is not in the TargetSite.", +"The Document is not indexed." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { +"description": "The value of the matcher that was used to match the Document.", +"id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", +"properties": { +"uri": { +"description": "If match by URI, the URI of the Document.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest", @@ -12766,7 +13018,7 @@ "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { -"description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -12917,7 +13169,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -13007,6 +13259,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", "type": "boolean" }, +"score": { +"description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].", +"format": "double", +"type": "number" +}, "startPos": { "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", "format": "int32", @@ -13156,7 +13413,7 @@ "type": "boolean" }, "projectId": { -"description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -13317,7 +13574,7 @@ "id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { "associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -13793,13 +14050,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"PUBLIC_WEBSITE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", -"The data store is used for public website search." +"The data store is used for public website search.", +"The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -13870,6 +14129,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1betaSchema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +}, +"workspaceConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", +"description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -16305,6 +16568,24 @@ "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", +"enum": [ +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" +], +"enumDescriptions": [ +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." +], +"type": "string" +}, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" @@ -17188,6 +17469,10 @@ "description": "Name of the string field as defined in the schema.", "type": "string" }, +"querySegment": { +"description": "Identifies the keywords within the search query that match a filter.", +"type": "string" +}, "values": { "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", "items": { @@ -17304,7 +17589,8 @@ "POTENTIAL_POLICY_VIOLATION", "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", -"JAIL_BREAKING_QUERY_IGNORED" +"JAIL_BREAKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", @@ -17314,7 +17600,8 @@ "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", -"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`." +"The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", +"The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -17745,7 +18032,7 @@ "type": "string" }, "projectId": { -"description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -18201,6 +18488,37 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { +"description": "Config to store data store type configuration for workspace data", +"id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", +"properties": { +"dasherCustomerId": { +"description": "Obfuscated Dasher customer ID.", +"type": "string" +}, +"type": { +"description": "The Google Workspace data source.", +"enum": [ +"TYPE_UNSPECIFIED", +"GOOGLE_DRIVE", +"GOOGLE_MAIL", +"GOOGLE_SITES", +"GOOGLE_CALENDAR", +"GOOGLE_GROUPS" +], +"enumDescriptions": [ +"Default value.", +"The data store is used to store content from Google Drive.", +"The data store is used to store content from Gmail.", +"The data store is used to store content from Google Sites.", +"The data store is used to store content from Google Calendar.", +"The data store is used to store content from Google Groups." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index 907e9a76983..545eaa672e4 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -9267,7 +9267,7 @@ } } }, -"revision": "20240701", +"revision": "20240808", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -14105,7 +14105,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14189,7 +14190,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" } @@ -14298,7 +14300,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14382,7 +14385,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -14492,7 +14496,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14576,7 +14581,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -14687,7 +14693,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14771,7 +14778,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "readOnly": true, "type": "string" @@ -15733,7 +15741,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15817,7 +15826,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -16644,7 +16654,8 @@ true "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16728,7 +16739,8 @@ true "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -18903,8 +18915,8 @@ true "Advertiser ID. If selected, all filter IDs must be Advertiser IDs that belong to the Partner specified in CreateSdfDownloadTaskRequest.", "Campaign ID. If selected, all filter IDs must be Campaign IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "Media Product ID. If selected, all filter IDs must be Media Product IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_MEDIA_PRODUCT`.", -"Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`.", -"Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`." +"Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`.", +"Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`,`FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`." ], "type": "string" } @@ -19760,7 +19772,8 @@ false "type": "array" }, "publisherReviewStatuses": { -"description": "Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information.", +"deprecated": true, +"description": "Publisher review statuses for the creative.", "items": { "$ref": "PublisherReviewStatus" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 2b1d5b15a31..b9984a32e23 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9222,7 +9222,7 @@ } } }, -"revision": "20240717", +"revision": "20240808", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -10048,7 +10048,8 @@ "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -10132,7 +10133,8 @@ "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -14819,7 +14821,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -14903,7 +14906,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" } @@ -15012,7 +15016,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15096,7 +15101,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -15206,7 +15212,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15290,7 +15297,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -15401,7 +15409,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -15485,7 +15494,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "readOnly": true, "type": "string" @@ -16447,7 +16457,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -16531,7 +16542,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, @@ -17372,7 +17384,8 @@ false "EXCHANGE_UNITY_GBID", "EXCHANGE_CHARTBOOST_GBID", "EXCHANGE_ADMOST_GBID", -"EXCHANGE_TOPON_GBID" +"EXCHANGE_TOPON_GBID", +"EXCHANGE_NETFLIX" ], "enumDescriptions": [ "Exchange is not specified or is unknown in this version.", @@ -17456,7 +17469,8 @@ false "Unity LevelPlay.", "Chartboost Mediation.", "AdMost.", -"TopOn." +"TopOn.", +"Netflix." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index d90be116745..e09a7d339b8 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -347,7 +347,7 @@ "type": "string" }, "parent": { -"description": "The parent resource name. The format of this value is as follows: locations/ LOCATION_ID", +"description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`", "location": "query", "type": "string" } @@ -391,7 +391,7 @@ "type": "string" }, "parent": { -"description": "The parent resource name. The format of this value is as follows: locations/ LOCATION_ID", +"description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`", "location": "path", "pattern": "^locations/[^/]+$", "required": true, @@ -424,7 +424,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -523,7 +523,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -580,7 +580,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -679,7 +679,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -813,7 +813,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1005,7 +1005,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1104,7 +1104,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1161,7 +1161,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1255,7 +1255,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1338,7 +1338,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1482,7 +1482,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1581,7 +1581,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1638,7 +1638,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1742,7 +1742,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1889,7 +1889,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1988,7 +1988,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -2147,7 +2147,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2246,7 +2246,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2307,7 +2307,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2335,7 +2335,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2363,7 +2363,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2395,7 +2395,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2494,7 +2494,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2579,7 +2579,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2683,7 +2683,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2727,7 +2727,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2759,7 +2759,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2858,7 +2858,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2943,7 +2943,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3047,7 +3047,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -3196,7 +3196,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3388,7 +3388,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3416,7 +3416,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3444,7 +3444,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3476,7 +3476,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3575,7 +3575,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3632,7 +3632,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3726,7 +3726,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3811,7 +3811,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3971,7 +3971,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4115,7 +4115,7 @@ ], "parameters": { "parent": { -"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4147,7 +4147,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4246,7 +4246,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4331,7 +4331,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4463,7 +4463,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4610,7 +4610,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4709,7 +4709,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4868,7 +4868,7 @@ ], "parameters": { "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4967,7 +4967,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", +"description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5015,7 +5015,7 @@ } } }, -"revision": "20240805", +"revision": "20240808", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6428,7 +6428,7 @@ "description": "Required. The key used by the encryption algorithm." }, "customAlphabet": { -"description": "This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/", +"description": "This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/``", "type": "string" }, "radix": { @@ -6524,6 +6524,10 @@ "pubSubNotification": { "$ref": "GooglePrivacyDlpV2PubSubNotification", "description": "Publish a message into the Pub/Sub topic." +}, +"tagResources": { +"$ref": "GooglePrivacyDlpV2TagResources", +"description": "Tags the profiled resources with the specified tag values." } }, "type": "object" @@ -7305,6 +7309,10 @@ "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": { +"inspectTemplateModifiedCadence": { +"$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", +"description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update." +}, "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 changed. Defaults to never.", "enum": [ @@ -8014,14 +8022,14 @@ "description": "The file cluster type." }, "fileExtensionsScanned": { -"description": "A sample of file types scanned in this cluster. Empty if no files were scanned.", +"description": "A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.", "items": { "$ref": "GooglePrivacyDlpV2FileExtensionInfo" }, "type": "array" }, "fileExtensionsSeen": { -"description": "A sample of file types seen in this cluster. Empty if no files were seen.", +"description": "A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content.", "items": { "$ref": "GooglePrivacyDlpV2FileExtensionInfo" }, @@ -11442,6 +11450,67 @@ }, "type": "object" }, +"GooglePrivacyDlpV2TagCondition": { +"description": "The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level.", +"id": "GooglePrivacyDlpV2TagCondition", +"properties": { +"sensitivityScore": { +"$ref": "GooglePrivacyDlpV2SensitivityScore", +"description": "Conditions attaching the tag to a resource on its profile having this sensitivity score." +}, +"tag": { +"$ref": "GooglePrivacyDlpV2TagValue", +"description": "The tag value to attach to resources." +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2TagResources": { +"description": "If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.", +"id": "GooglePrivacyDlpV2TagResources", +"properties": { +"lowerDataRiskToLow": { +"description": "Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.", +"type": "boolean" +}, +"profileGenerationsToTag": { +"description": "The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`.", +"items": { +"enum": [ +"PROFILE_GENERATION_UNSPECIFIED", +"PROFILE_GENERATION_NEW", +"PROFILE_GENERATION_UPDATE" +], +"enumDescriptions": [ +"Unused.", +"The profile is the first profile for the resource.", +"The profile is an update to a previous profile." +], +"type": "string" +}, +"type": "array" +}, +"tagConditions": { +"description": "The tags to associate with different conditions.", +"items": { +"$ref": "GooglePrivacyDlpV2TagCondition" +}, +"type": "array" +} +}, +"type": "object" +}, +"GooglePrivacyDlpV2TagValue": { +"description": "A value of a tag.", +"id": "GooglePrivacyDlpV2TagValue", +"properties": { +"namespacedValue": { +"description": "The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\".", +"type": "string" +} +}, +"type": "object" +}, "GooglePrivacyDlpV2TaggedField": { "description": "A column with a semantic tag attached.", "id": "GooglePrivacyDlpV2TaggedField", @@ -11532,7 +11601,7 @@ }, "timestampField": { "$ref": "GooglePrivacyDlpV2FieldId", -"description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." +"description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index 7707a17ba6d..74611b19e29 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1042,7 +1042,7 @@ } } }, -"revision": "20240716", +"revision": "20240813", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4471,6 +4471,10 @@ true "$ref": "GoogleCloudDocumentaiV1GcsDocument", "description": "A raw document on Google Cloud Storage." }, +"imagelessMode": { +"description": "Optional. Option to remove images from the document.", +"type": "boolean" +}, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1Document", "description": "An inline document proto." diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index ea38690adb3..50bdfe80234 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1284,7 +1284,7 @@ } } }, -"revision": "20240716", +"revision": "20240813", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -9073,6 +9073,10 @@ true "$ref": "GoogleCloudDocumentaiV1beta3GcsDocument", "description": "A raw document on Google Cloud Storage." }, +"imagelessMode": { +"description": "Optional. Option to remove images from the document.", +"type": "boolean" +}, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1beta3Document", "description": "An inline document proto." diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index e127a15032f..9b2871482df 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -3869,7 +3869,7 @@ } } }, -"revision": "20240730", +"revision": "20240809", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -5469,7 +5469,7 @@ }, "lastModifyingUser": { "$ref": "User", -"description": "Output only. The last user to modify this file." +"description": "Output only. The last user to modify this file. This field is only populated when the last modification was performed by a signed-in user." }, "lastModifyingUserName": { "description": "Output only. Name of the last user to modify this file.", @@ -5547,7 +5547,7 @@ "type": "array" }, "parents": { -"description": "Collection of parent folders which contain this file. If not specified as part of an insert request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests can also use the `addParents` and `removeParents` parameters to modify the parents list.", +"description": "The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of an insert request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", "items": { "$ref": "ParentReference" }, @@ -6049,7 +6049,7 @@ "type": "object" }, "ParentReference": { -"description": "A reference to a file's parent. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.", +"description": "A reference to a file's parent. A file can only have one parent folder; specifying multiple parents isn't supported. Some resource methods (such as `parents.get`) require a `parentId`. Use the `parents.list` method to retrieve the ID for a parent.", "id": "ParentReference", "properties": { "id": { @@ -6394,7 +6394,7 @@ }, "lastModifyingUser": { "$ref": "User", -"description": "Output only. The last user to modify this revision." +"description": "Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user." }, "lastModifyingUserName": { "description": "Output only. Name of the last user to modify this revision.", diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index de2016367fe..6cef24cc95b 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2523,7 +2523,7 @@ } } }, -"revision": "20240730", +"revision": "20240809", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3735,7 +3735,7 @@ }, "lastModifyingUser": { "$ref": "User", -"description": "Output only. The last user to modify the file." +"description": "Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user." }, "linkShareMetadata": { "description": "Contains details about the link URLs that clients are using to refer to this item.", @@ -3793,7 +3793,7 @@ "type": "array" }, "parents": { -"description": "The IDs of the parent folders which contain the file. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parents of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", +"description": "The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.", "items": { "type": "string" }, @@ -4494,7 +4494,7 @@ }, "lastModifyingUser": { "$ref": "User", -"description": "Output only. The last user to modify this revision." +"description": "Output only. The last user to modify this revision. This field is only populated when the last modification was performed by a signed-in user." }, "md5Checksum": { "description": "Output only. The MD5 checksum of the revision's content. This is only applicable to files with binary content in Drive.", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index e005b9780d1..14e2d5c9920 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240808", +"revision": "20240813", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -290,7 +290,7 @@ "The finish reason is unspecified.", "Token generation reached a natural stopping point or a configured stop sequence.", "Token generation reached the configured maximum output tokens.", -"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, Candidate.content is empty if content filters blocks the output.", +"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", "Token generation stopped because the content potentially contains copyright violations.", "All other reasons that stopped the token generation.", "Token generation stopped because the content contains forbidden terms.", @@ -503,9 +503,9 @@ ], "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 response.", -"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." +"Default model behavior, model decides to predict either function calls or natural language response.", +"Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", +"Model will not predict any function calls. Model behavior is same as when not passing any function declarations." ], "type": "string" } @@ -1305,11 +1305,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VertexAISearch": { -"description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation", +"description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { "datastore": { -"description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", +"description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index e9350a6d94d..35f7d2d65e7 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240727", +"revision": "20240809", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2593,6 +2593,44 @@ }, "type": "object" }, +"CompliancePostureConfig": { +"description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", +"id": "CompliancePostureConfig", +"properties": { +"complianceStandards": { +"description": "List of enabled compliance standards.", +"items": { +"$ref": "ComplianceStandard" +}, +"type": "array" +}, +"mode": { +"description": "Defines the enablement mode for Compliance Posture.", +"enum": [ +"MODE_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Default value not specified.", +"Disables Compliance Posture features on the cluster.", +"Enables Compliance Posture features on the cluster." +], +"type": "string" +} +}, +"type": "object" +}, +"ComplianceStandard": { +"id": "ComplianceStandard", +"properties": { +"standard": { +"description": "Name of the compliance standard.", +"type": "string" +} +}, +"type": "object" +}, "ConfigManagementConfigSync": { "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", @@ -3559,6 +3597,10 @@ "$ref": "BinaryAuthorizationConfig", "description": "Optional. Enable/Disable binary authorization features for the cluster." }, +"compliancePostureConfig": { +"$ref": "CompliancePostureConfig", +"description": "Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask." +}, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture features for the cluster." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index ce2bc341f8b..7de05b662e4 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2185,7 +2185,7 @@ } } }, -"revision": "20240727", +"revision": "20240809", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2817,6 +2817,44 @@ }, "type": "object" }, +"CompliancePostureConfig": { +"description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", +"id": "CompliancePostureConfig", +"properties": { +"complianceStandards": { +"description": "List of enabled compliance standards.", +"items": { +"$ref": "ComplianceStandard" +}, +"type": "array" +}, +"mode": { +"description": "Defines the enablement mode for Compliance Posture.", +"enum": [ +"MODE_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Default value not specified.", +"Disables Compliance Posture features on the cluster.", +"Enables Compliance Posture features on the cluster." +], +"type": "string" +} +}, +"type": "object" +}, +"ComplianceStandard": { +"id": "ComplianceStandard", +"properties": { +"standard": { +"description": "Name of the compliance standard.", +"type": "string" +} +}, +"type": "object" +}, "ConfigManagementBinauthzConfig": { "description": "Configuration for Binauthz", "id": "ConfigManagementBinauthzConfig", @@ -3843,6 +3881,10 @@ "$ref": "BinaryAuthorizationConfig", "description": "Optional. Enable/Disable binary authorization features for the cluster." }, +"compliancePostureConfig": { +"$ref": "CompliancePostureConfig", +"description": "Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask." +}, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture features for the cluster." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 77ad6a42aa1..59b7fe4c387 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2111,7 +2111,7 @@ } } }, -"revision": "20240727", +"revision": "20240809", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2627,6 +2627,44 @@ }, "type": "object" }, +"CompliancePostureConfig": { +"description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", +"id": "CompliancePostureConfig", +"properties": { +"complianceStandards": { +"description": "List of enabled compliance standards.", +"items": { +"$ref": "ComplianceStandard" +}, +"type": "array" +}, +"mode": { +"description": "Defines the enablement mode for Compliance Posture.", +"enum": [ +"MODE_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Default value not specified.", +"Disables Compliance Posture features on the cluster.", +"Enables Compliance Posture features on the cluster." +], +"type": "string" +} +}, +"type": "object" +}, +"ComplianceStandard": { +"id": "ComplianceStandard", +"properties": { +"standard": { +"description": "Name of the compliance standard.", +"type": "string" +} +}, +"type": "object" +}, "ConfigManagementBinauthzConfig": { "description": "Configuration for Binauthz", "id": "ConfigManagementBinauthzConfig", @@ -3653,6 +3691,10 @@ "$ref": "BinaryAuthorizationConfig", "description": "Optional. Enable/Disable binary authorization features for the cluster." }, +"compliancePostureConfig": { +"$ref": "CompliancePostureConfig", +"description": "Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask." +}, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture features for the cluster." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json new file mode 100644 index 00000000000..ad0b8c0c97a --- /dev/null +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -0,0 +1,435 @@ +{ +"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://gkehub.googleapis.com/", +"batchPath": "batch", +"canonicalName": "GKE Hub", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", +"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": "gkehub:v2", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://gkehub.mtls.googleapis.com/", +"name": "gkehub", +"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": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "gkehub.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service.", +"flatPath": "v2/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "gkehub.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "gkehub.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"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": "v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "gkehub.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "Operation" +}, +"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": "v2/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "gkehub.projects.locations.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/[^/]+$", +"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": "v2/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20240809", +"rootUrl": "https://gkehub.googleapis.com/", +"schemas": { +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"GoogleRpcStatus": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "GoogleRpcStatus", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "GKE Hub API", +"version": "v2", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json new file mode 100644 index 00000000000..0b412a8ffd9 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -0,0 +1,435 @@ +{ +"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://gkehub.googleapis.com/", +"batchPath": "batch", +"canonicalName": "GKE Hub", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", +"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": "gkehub:v2beta", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://gkehub.mtls.googleapis.com/", +"name": "gkehub", +"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": { +"methods": { +"get": { +"description": "Gets information about a location.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}", +"httpMethod": "GET", +"id": "gkehub.projects.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name for the location.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+name}", +"response": { +"$ref": "Location" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists information about the supported locations for this service.", +"flatPath": "v2beta/projects/{projectsId}/locations", +"httpMethod": "GET", +"id": "gkehub.projects.locations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"name": { +"description": "The resource that owns the locations collection, if applicable.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The maximum number of results to return. If not set, the service selects a default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", +"location": "query", +"type": "string" +} +}, +"path": "v2beta/{+name}/locations", +"response": { +"$ref": "ListLocationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "gkehub.projects.locations.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+name}:cancel", +"request": { +"$ref": "CancelOperationRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"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": "v2beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "gkehub.projects.locations.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+name}", +"response": { +"$ref": "Operation" +}, +"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": "v2beta/projects/{projectsId}/locations/{locationsId}/operations", +"httpMethod": "GET", +"id": "gkehub.projects.locations.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/[^/]+$", +"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": "v2beta/{+name}/operations", +"response": { +"$ref": "ListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +}, +"revision": "20240809", +"rootUrl": "https://gkehub.googleapis.com/", +"schemas": { +"CancelOperationRequest": { +"description": "The request message for Operations.CancelOperation.", +"id": "CancelOperationRequest", +"properties": {}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"GoogleRpcStatus": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "GoogleRpcStatus", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", +"format": "int32", +"type": "integer" +}, +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", +"type": "string" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "The response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "A list of locations that matches the specified filter in the request.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +} +}, +"type": "object" +}, +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", +"type": "string" +}, +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" +}, +"type": "array" +} +}, +"type": "object" +}, +"Location": { +"description": "A resource that represents a Google Cloud location.", +"id": "Location", +"properties": { +"displayName": { +"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", +"type": "object" +}, +"locationId": { +"description": "The canonical id for this location. For example: `\"us-east1\"`.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata. For example the available capacity at the given location.", +"type": "object" +}, +"name": { +"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", +"type": "string" +} +}, +"type": "object" +}, +"Operation": { +"description": "This resource represents a long-running operation that is the result of a network API call.", +"id": "Operation", +"properties": { +"done": { +"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", +"type": "boolean" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "The error result of the operation in case of failure or cancellation." +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" +}, +"name": { +"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", +"type": "string" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", +"type": "object" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "GKE Hub API", +"version": "v2beta", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 221edf69d4d..c7e4456b9cd 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -4201,6 +4201,53 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"Encounter-everything": { +"description": "Retrieves an Encounter resource and resources related to that Encounter. Implements the FHIR extended operation Encounter-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/encounter-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/encounter-operations.html#everything), or [R4](https://hl7.org/implement/standards/fhir/R4/encounter-operation-everything.html). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The Encounter resource itself. * All the resources directly referenced by the Encounter resource, including attachments and binaries. * Resources directly referencing the Encounter resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the Encounter Compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-encounter.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-encounter.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-encounter.html)), which details the eligible resource types and referencing search parameters. * Resources referencing to the Encounter resource through the \"http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter\" extension.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Encounter/{EncounterId}/$everything", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.fhirStores.fhir.Encounter-everything", +"parameterOrder": [ +"name" +], +"parameters": { +"_count": { +"description": "Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"_page_token": { +"description": "Optional. Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is \"previous\" or \"next\". Omit `_page_token` if no previous request has been made.", +"location": "query", +"type": "string" +}, +"_since": { +"description": "Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.", +"location": "query", +"type": "string" +}, +"_type": { +"description": "Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple `_type` parameters isn't supported. For example, the result of `_type=Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter` instead.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Name of the Encounter resource for which the information is required.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Encounter/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/$everything", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "Observation-lastn": { "description": "Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Observation/$lastn", @@ -5701,7 +5748,7 @@ } } }, -"revision": "20240731", +"revision": "20240808", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index 9c6e6ad7a11..0bd850b5e2d 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -1351,7 +1351,7 @@ "type": "string" }, "readMask": { -"description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.", +"description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1380,34 +1380,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"replay": { -"description": "Re-execute an existing execution, with same request parameters and execution strategy", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay", -"httpMethod": "POST", -"id": "integrations.projects.locations.integrations.executions.replay", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:replay", -"request": { -"$ref": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest" -}, -"response": { -"$ref": "GoogleCloudIntegrationsV1alphaReplayExecutionResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } }, "resources": { @@ -1743,7 +1715,7 @@ "type": "string" }, "parent": { -"description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\". 3. projects//locations/-/integrations/- Meaning: \"List versions (with filter) for a client\".", +"description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", "required": true, @@ -2406,34 +2378,6 @@ "resources": { "executions": { "methods": { -"cancel": { -"description": "Cancellation of an execution", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:cancel", -"httpMethod": "POST", -"id": "integrations.projects.locations.products.integrations.executions.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/executions/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:cancel", -"request": { -"$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest" -}, -"response": { -"$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "download": { "description": "Download the execution.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/executions/{executionsId}:download", @@ -2589,7 +2533,7 @@ "type": "string" }, "readMask": { -"description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.", +"description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in Execution will be filled and returned. Supported fields: trigger_id execution_method create_time update_time execution_details execution_details.state execution_details.execution_snapshots execution_details.attempt_stats execution_details.event_execution_snapshots_size request_parameters cloud_logging_details snapshot_number replay_info", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2912,7 +2856,7 @@ "type": "string" }, "parent": { -"description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\". 3. projects//locations/-/integrations/- Meaning: \"List versions (with filter) for a client\".", +"description": "Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: \"List versions (with filter) for a particular integration\". 2. projects//locations//integrations/- Meaning: \"List versions (with filter) for a client within a particular region\".", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+$", "required": true, @@ -4140,7 +4084,7 @@ } } }, -"revision": "20240707", +"revision": "20240812", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -5115,9 +5059,13 @@ false "type": "object" }, "EnterpriseCrmEventbusProtoEventExecutionDetails": { -"description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11", +"description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12", "id": "EnterpriseCrmEventbusProtoEventExecutionDetails", "properties": { +"cancelReason": { +"description": "If the execution is manually canceled, this field will contain the reason for cancellation.", +"type": "string" +}, "eventAttemptStats": { "items": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" @@ -5366,7 +5314,6 @@ false "type": "boolean" }, "source": { -"description": "LINT.ThenChange(//depot/google3/enterprise/crm/eventbus/proto/product.proto:product, //depot/google3/java/com/google/enterprise/crm/integrationplatform/api/utils/ConverterUtils.java:source_to_product)", "enum": [ "SOURCE_UNSPECIFIED", "APIGEE", @@ -5752,7 +5699,7 @@ false "", "", "", -"next id: 24" +"" ], "type": "string" } @@ -5767,10 +5714,6 @@ false "description": "The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.", "type": "string" }, -"sanitizeOptions": { -"$ref": "EnterpriseCrmLoggingGwsSanitizeOptions", -"description": "Contains the scrubbing options, such as whether to scrub, obfuscate, etc." -}, "seedPeriod": { "enum": [ "SEED_PERIOD_UNSPECIFIED", @@ -5800,10 +5743,6 @@ false "Hash computations include the param name." ], "type": "string" -}, -"shorteningLimits": { -"$ref": "EnterpriseCrmLoggingGwsFieldLimits", -"description": "Contains the field limits for shortening, such as max string length and max array length." } }, "type": "object" @@ -6955,7 +6894,7 @@ false "", "Internal IP tasks that should not be available in the UI.", "Tasks that are relevant to cloud systems teams and typically", -"include connecting to Vector salesforce, CRM Hub Spanner etc. Task entities that derive from a custom task template.", +"Task entities that derive from a custom task template.", "Category to show task recommendations" ], "type": "string" @@ -7541,9 +7480,13 @@ false "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails": { -"description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 11", +"description": "Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 12", "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionDetails", "properties": { +"cancelReason": { +"description": "If the execution is manually canceled, this field will contain the reason for cancellation.", +"type": "string" +}, "eventAttemptStats": { "items": { "$ref": "EnterpriseCrmEventbusProtoEventExecutionDetailsEventAttemptStats" @@ -7613,7 +7556,7 @@ false "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo": { -"description": "Contains all the execution details for a workflow instance. Next available id: 26", +"description": "Contains all the execution details for a workflow instance. Next available id: 27", "id": "EnterpriseCrmFrontendsEventbusProtoEventExecutionInfo", "properties": { "clientId": { @@ -7652,6 +7595,10 @@ false "$ref": "EnterpriseCrmEventbusProtoExecutionTraceInfo", "description": "Execution trace info to aggregate parent-child executions." }, +"integrationVersionUserLabel": { +"description": "User-defined label that annotates the executed integration version.", +"type": "string" +}, "lastModifiedTime": { "description": "Auto-generated.", "format": "int64", @@ -8738,144 +8685,6 @@ false }, "type": "object" }, -"EnterpriseCrmLoggingGwsFieldLimits": { -"description": "Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6", -"id": "EnterpriseCrmLoggingGwsFieldLimits", -"properties": { -"logAction": { -"enum": [ -"LOG_ACTION_UNSPECIFIED", -"DONT_LOG", -"LOG" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -}, -"logType": { -"description": "To which type(s) of logs the limits apply.", -"items": { -"enum": [ -"LOG_TYPE_UNSPECIFIED", -"GWS", -"GTS", -"ALL" -], -"enumDescriptions": [ -"", -"Limits apply when log detail records are written to GWS.", -"Limits apply when log detail records are written to GTS (e.g., RecordIO files).", -"Limits apply to *all* output log types." -], -"type": "string" -}, -"type": "array" -}, -"maxArraySize": { -"description": "maximum array size. If the array exceds this size, the field (list) is truncated.", -"format": "int32", -"type": "integer" -}, -"maxStringLength": { -"description": "maximum string length. If the field exceeds this amount the field is shortened.", -"format": "int32", -"type": "integer" -}, -"shortenerType": { -"enum": [ -"SHORTENER_TYPE_UNSPECIFIED", -"SHORTEN", -"HASH", -"SHORTEN_WITH_HASH", -"SHORTEN_EMAIL", -"SHORTEN_EMAIL_WITH_HASH", -"SHORTEN_DOMAIN" -], -"enumDescriptions": [ -"", -"String is shortened to max_string_length.", -"String is replaced by its hex-string hash.", -"String is replaced by a combination of string shortening and a hex-string hash.", -"String shortening for email addresses. Shortening may be done on the user and/or domain portion of the email address.", -"String is replaced by a combination of string shortening and a hex-string hash for an email address.", -"Shortens a domain name (e.g., as part of an email address or URL)." -], -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseCrmLoggingGwsSanitizeOptions": { -"description": "Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5", -"id": "EnterpriseCrmLoggingGwsSanitizeOptions", -"properties": { -"isAlreadySanitized": { -"description": "If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.", -"type": "boolean" -}, -"logType": { -"description": "To which type(s) of logs the sanitize options apply.", -"items": { -"enum": [ -"LOG_TYPE_UNSPECIFIED", -"GWS", -"GTS", -"ALL" -], -"enumDescriptions": [ -"", -"Limits apply when log detail records are written to GWS.", -"Limits apply when log detail records are written to GTS (e.g., RecordIO files).", -"Limits apply to *all* output log types." -], -"type": "string" -}, -"type": "array" -}, -"privacy": { -"enum": [ -"PRIVACY_TYPE_UNSPECIFIED", -"NOT_PII", -"PII", -"SPII", -"UNSURE" -], -"enumDescriptions": [ -"", -"Field does *NOT* contain PII or sensitive data.", -"Field contains PII.", -"Field contains Sensitive PII.", -"Unsure if field contains PII." -], -"type": "string" -}, -"sanitizeType": { -"enum": [ -"SANITIZE_TYPE_UNSPECIFIED", -"SCRUB", -"ANONYMIZE", -"ANONYMIZE_LIMITED_REPEATABLE", -"OBFUSCATE", -"ENCRYPT", -"DO_NOT_SANITIZE" -], -"enumDescriptions": [ -"", -"Replace value with a scrubbed value (usu. a constant).", -"Transform a value so that it cannot be tracked across events. However, a given value, is transformed to the same value *within* an event. E.g., \"foo.com\" is transformed to \"0xabcdef\" for event 1001, and to \"0xfedcba\" for event 1002.", -"Transform values as with ANONYMIZER, but the same transformation is repeated for a limited time (e.g., 1 day).", -"The value is transformed using a well-defined obfuscator (e.g., D3_CUSTOMER_ID).", -"The value is encrypted.", -"No sanitization is required." -], -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudConnectorsV1AuthConfig": { "description": "AuthConfig defines details of a authentication type.", "id": "GoogleCloudConnectorsV1AuthConfig", @@ -9123,6 +8932,10 @@ false "description": "Connection represents an instance of connector.", "id": "GoogleCloudConnectorsV1Connection", "properties": { +"asyncOperationsEnabled": { +"description": "Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.", +"type": "boolean" +}, "authConfig": { "$ref": "GoogleCloudConnectorsV1AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." @@ -9218,6 +9031,11 @@ false "description": "Output only. Eventing Runtime Data.", "readOnly": true }, +"host": { +"description": "Output only. The name of the Hostname of the Service Directory service with TLS.", +"readOnly": true, +"type": "string" +}, "imageLocation": { "description": "Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}", "readOnly": true, @@ -9289,6 +9107,11 @@ false "description": "Optional. Suspended indicates if a user has suspended a connection or not.", "type": "boolean" }, +"tlsServiceDirectory": { +"description": "Output only. The name of the Service Directory service with TLS.", +"readOnly": true, +"type": "string" +}, "updateTime": { "description": "Output only. Updated time.", "format": "google-datetime", @@ -9361,6 +9184,25 @@ false ], "type": "string" }, +"deploymentModelMigrationState": { +"description": "Output only. Status of the deployment model migration.", +"enum": [ +"DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED", +"IN_PROGRESS", +"COMPLETED", +"ROLLEDBACK", +"ROLLBACK_IN_PROGRESS" +], +"enumDescriptions": [ +"Deployment model migration state is not specified.", +"Deployment model migration is in progress.", +"Deployment model migration is completed.", +"Deployment model migration rolledback.", +"Deployment model migration rollback in progress." +], +"readOnly": true, +"type": "string" +}, "hpaConfig": { "$ref": "GoogleCloudConnectorsV1HPAConfig", "description": "Output only. HPA autoscaling config.", @@ -9372,6 +9214,12 @@ false "readOnly": true, "type": "string" }, +"maxInstanceRequestConcurrency": { +"description": "Output only. Max instance request concurrency.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "ratelimitThreshold": { "description": "Output only. Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -10045,23 +9893,6 @@ false }, "type": "object" }, -"GoogleCloudIntegrationsV1alphaCancelExecutionRequest": { -"description": "Request for cancelling an execution.", -"id": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest", -"properties": {}, -"type": "object" -}, -"GoogleCloudIntegrationsV1alphaCancelExecutionResponse": { -"description": "Response for cancelling an execution.", -"id": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse", -"properties": { -"isCanceled": { -"description": "True if cancellation performed successfully", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudIntegrationsV1alphaCertificate": { "description": "The certificate definition", "id": "GoogleCloudIntegrationsV1alphaCertificate", @@ -10081,7 +9912,7 @@ false "type": "string" }, "credentialId": { -"description": "Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY", +"description": "Immutable. Credential id that will be used to register with trawler", "type": "string" }, "description": { @@ -11326,7 +11157,8 @@ false "BOOLEAN_ARRAY", "JSON_VALUE", "PROTO_VALUE", -"PROTO_ARRAY" +"PROTO_ARRAY", +"NON_SERIALIZABLE_OBJECT" ], "enumDescriptions": [ "Unspecified.", @@ -11340,7 +11172,8 @@ false "Boolean Array.", "Json.", "Proto Value (Internal use only).", -"Proto Array (Internal use only)." +"Proto Array (Internal use only).", +"// Non-serializable object (Internal use only)." ], "type": "string" }, @@ -11348,6 +11181,10 @@ false "$ref": "GoogleCloudIntegrationsV1alphaValueType", "description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." }, +"description": { +"description": "Optional. Description of the parameter.", +"type": "string" +}, "displayName": { "description": "The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\".", "type": "string" @@ -12154,7 +11991,8 @@ false "BOOLEAN_ARRAY", "JSON_VALUE", "PROTO_VALUE", -"PROTO_ARRAY" +"PROTO_ARRAY", +"NON_SERIALIZABLE_OBJECT" ], "enumDescriptions": [ "Unspecified.", @@ -12168,7 +12006,8 @@ false "Boolean Array.", "Json.", "Proto Value (Internal use only).", -"Proto Array (Internal use only)." +"Proto Array (Internal use only).", +"// Non-serializable object (Internal use only)." ], "type": "string" }, @@ -12186,7 +12025,8 @@ false "BOOLEAN_ARRAY", "JSON_VALUE", "PROTO_VALUE", -"PROTO_ARRAY" +"PROTO_ARRAY", +"NON_SERIALIZABLE_OBJECT" ], "enumDescriptions": [ "Unspecified.", @@ -12200,7 +12040,8 @@ false "Boolean Array.", "Json.", "Proto Value (Internal use only).", -"Proto Array (Internal use only)." +"Proto Array (Internal use only).", +"// Non-serializable object (Internal use only)." ], "type": "string" } @@ -12347,40 +12188,6 @@ false }, "type": "object" }, -"GoogleCloudIntegrationsV1alphaReplayExecutionRequest": { -"description": "Request for replaying an execution Next ID: 3", -"id": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest", -"properties": { -"replayReason": { -"description": "Optional. The user provided reason for replaying the execution.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudIntegrationsV1alphaReplayExecutionResponse": { -"description": "Response for replaying an execution Next ID: 4", -"id": "GoogleCloudIntegrationsV1alphaReplayExecutionResponse", -"properties": { -"executionId": { -"description": "The id of the execution corresponding to this run of integration.", -"type": "string" -}, -"outputParameters": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. The parameters would only be present in case of synchrounous execution Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.", -"type": "object" -}, -"replayedExecutionId": { -"description": "The execution id which is replayed", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest": { "description": "Request for [Suspensions.ResolveSuspensions].", "id": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest", @@ -13097,10 +12904,6 @@ false }, "type": "array" }, -"clientId": { -"description": "Required. Client id with which Template is associated", -"type": "string" -}, "components": { "description": "Optional. Components being used in the template. This could be used to categorize and filter.", "items": { @@ -13379,7 +13182,7 @@ false "type": "string" }, "triggerId": { -"description": "Optional. The backend trigger ID.", +"description": "Optional. Auto-generated trigger ID. The ID is based on the properties that you define in the trigger config. For example, for an API trigger, the trigger ID follows the format: api_trigger/TRIGGER_NAME Where trigger config has properties with value {\"Trigger name\": TRIGGER_NAME}", "type": "string" }, "triggerNumber": { diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index 62689be83cf..836d42fa4c5 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -416,7 +416,7 @@ } } }, -"revision": "20240716", +"revision": "20240809", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -513,6 +513,13 @@ }, "type": "array" }, +"intendedCountry": { +"description": "Optional. List of countries to show this product in. Countries provided in this attribute will override any of the countries configured at feed level. The values should be: the [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries in which this item will be shown.", +"items": { +"type": "string" +}, +"type": "array" +}, "itemGroupId": { "description": "The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid.", "type": "string" @@ -697,10 +704,34 @@ "description": "The destination status.", "id": "DestinationStatus", "properties": { +"approvedCountries": { +"description": "Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "destination": { "description": "The name of the destination.", "type": "string" }, +"disapprovedCountries": { +"description": "Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"pendingCountries": { +"description": "Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "status": { "description": "The status of the destination.", "enum": [ @@ -1224,6 +1255,10 @@ }, "type": "array" }, +"feedLabel": { +"description": "Optional. The feed label for the product.", +"type": "string" +}, "issues": { "description": "A server-generated list of issues associated with the product.", "items": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index 8272febb31a..6ffd90dafed 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20240711", +"revision": "20240808", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3791,6 +3791,16 @@ "description": "Optional. Total memory in bytes limited by db deployment.", "format": "int64", "type": "string" +}, +"physicalCoreCount": { +"description": "Optional. Number of total physical cores.", +"format": "int32", +"type": "integer" +}, +"physicalCoreLimit": { +"description": "Optional. Number of total physical cores limited by db deployment.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -3845,6 +3855,10 @@ "description": "The instance's name.", "type": "string" }, +"network": { +"$ref": "DatabaseInstanceNetwork", +"description": "Optional. Networking details." +}, "role": { "description": "The instance role in the database engine.", "enum": [ @@ -3864,6 +3878,31 @@ }, "type": "object" }, +"DatabaseInstanceNetwork": { +"description": "Network details of a database instance.", +"id": "DatabaseInstanceNetwork", +"properties": { +"hostNames": { +"description": "Optional. The instance's host names.", +"items": { +"type": "string" +}, +"type": "array" +}, +"ipAddresses": { +"description": "Optional. The instance's IP addresses.", +"items": { +"type": "string" +}, +"type": "array" +}, +"primaryMacAddress": { +"description": "Optional. The instance's primary MAC address.", +"type": "string" +} +}, +"type": "object" +}, "DatabaseObjects": { "description": "Details of a group of database objects.", "id": "DatabaseObjects", @@ -7004,6 +7043,11 @@ false "description": "Output only. Database licensing monthly cost for this preference set. Only present for databases.", "readOnly": true }, +"monthlyCostGcveProtected": { +"$ref": "Money", +"description": "Output only. GCVE Protected nodes cost for this preference set.", +"readOnly": true +}, "monthlyCostNetworkEgress": { "$ref": "Money", "description": "Output only. Network Egress monthly cost for this preference set. Only present for virtual machines.", @@ -7019,6 +7063,11 @@ false "description": "Output only. Miscellaneous monthly cost for this preference set.", "readOnly": true }, +"monthlyCostPortableVmwareLicense": { +"$ref": "Money", +"description": "Output only. VMware portable license monthly cost for this preference set. Only present for VMware target with portable license service type. This cost is not paid to google, but is an estimate of license costs paid to VMware.", +"readOnly": true +}, "monthlyCostStorage": { "$ref": "Money", "description": "Output only. Storage monthly cost for this preference set.", @@ -7736,7 +7785,13 @@ false "SqlServerSchemaDetails": { "description": "Specific details for a SqlServer database.", "id": "SqlServerSchemaDetails", -"properties": {}, +"properties": { +"clrObjectCount": { +"description": "Optional. SqlServer number of CLR objects.", +"format": "int32", +"type": "integer" +} +}, "type": "object" }, "SqlServerServerFlag": { @@ -7873,6 +7928,48 @@ false }, "type": "object" }, +"VMwareEngineMachinePreferences": { +"description": "The type of machines to consider when calculating virtual machine migration insights and recommendations for VMware Engine. Not all machine types are available in all zones and regions.", +"id": "VMwareEngineMachinePreferences", +"properties": { +"allowedMachineSeries": { +"description": "Optional. VMware Engine on Google Cloud machine series to consider for insights and recommendations. If empty, no restriction is applied on the machine series.", +"items": { +"$ref": "MachineSeries" +}, +"type": "array" +}, +"protectedNodes": { +"description": "Optional. Whether to use VMware Engine Protected offering.", +"enum": [ +"PROTECTED_NODES_UNSPECIFIED", +"PROTECTED_NODES_ENABLED", +"PROTECTED_NODES_DISABLED" +], +"enumDescriptions": [ +"Unspecified protected nodes preference.", +"Use only protected nodes for the selected allowed_machine_series.", +"Do not use protected nodes." +], +"type": "string" +}, +"storageOnlyNodes": { +"description": "Optional. Whether to use storage-only nodes, if those are available.", +"enum": [ +"STORAGE_ONLY_NODES_UNSPECIFIED", +"STORAGE_ONLY_NODES_ENABLED", +"STORAGE_ONLY_NODES_DISABLED" +], +"enumDescriptions": [ +"Unspecified storage-only nodes preference.", +"Use storage-only nodes for selected allowed_machine_series, if available.", +"Do not use storage-only nodes." +], +"type": "string" +} +}, +"type": "object" +}, "ValidateImportJobRequest": { "description": "A request to validate an import job.", "id": "ValidateImportJobRequest", @@ -8323,11 +8420,34 @@ false "format": "double", "type": "number" }, +"licenseDiscountPercentage": { +"description": "Optional. Discount percentage for the license type offered to you by Broadcom. Must be between 0 and 100. Only valid when service_type is set to SERVICE_TYPE_PORTABLE_LICENSE.", +"format": "float", +"type": "number" +}, +"machinePreferences": { +"$ref": "VMwareEngineMachinePreferences", +"description": "Optional. Preferences concerning the machine types to consider on Google Cloud VMware Engine." +}, "memoryOvercommitRatio": { "description": "Memory overcommit ratio. Acceptable values are 1.0, 1.25, 1.5, 1.75 and 2.0.", "format": "double", "type": "number" }, +"serviceType": { +"description": "Optional. VMWare Service Type (Fully Licensed or Portable License).", +"enum": [ +"SERVICE_TYPE_UNSPECIFIED", +"SERVICE_TYPE_FULLY_LICENSED", +"SERVICE_TYPE_PORTABLE_LICENSE" +], +"enumDescriptions": [ +"Same as SERVICE_TYPE_FULLY_LICENSED.", +"Google provided VCF license.", +"Bring Your Own License." +], +"type": "string" +}, "storageDeduplicationCompressionRatio": { "description": "The Deduplication and Compression ratio is based on the logical (Used Before) space required to store data before applying deduplication and compression, in relation to the physical (Used After) space required after applying deduplication and compression. Specifically, the ratio is the Used Before space divided by the Used After space. For example, if the Used Before space is 3 GB, but the physical Used After space is 1 GB, the deduplication and compression ratio is 3x. Acceptable values are between 1.0 and 4.0.", "format": "double", diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index ea4e54dd235..6a7302f6d9d 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2812,7 +2812,7 @@ } } }, -"revision": "20240717", +"revision": "20240807", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2963,13 +2963,15 @@ "STATE_UNSPECIFIED", "VALID", "CONNECTION_POLICY_MISSING", -"POLICY_LIMIT_REACHED" +"POLICY_LIMIT_REACHED", +"CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" ], "enumDescriptions": [ "Default state, when Connection Map is created initially.", "Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit.", "No Service Connection Policy found for this network and Service Class", -"Service Connection Policy limit reached for this network and Service Class" +"Service Connection Policy limit reached for this network and Service Class", +"The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy." ], "readOnly": true, "type": "string" @@ -3620,6 +3622,14 @@ }, "type": "array" }, +"producerVpcSpokes": { +"description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "uri": { "description": "Required. The URI of the VPC network resource.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index 25b7081eef2..0dbb6a92f60 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, -"revision": "20240624", +"revision": "20240807", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -1393,6 +1393,10 @@ "description": "User-defined labels.", "type": "object" }, +"migration": { +"$ref": "Migration", +"description": "Optional. Should be present if usage is set to FOR_MIGRATION." +}, "name": { "description": "Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string" @@ -1456,12 +1460,14 @@ "enum": [ "USAGE_UNSPECIFIED", "FOR_VPC", -"EXTERNAL_TO_VPC" +"EXTERNAL_TO_VPC", +"FOR_MIGRATION" ], "enumDescriptions": [ "Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.", "A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.", -"Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect." +"Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.", +"Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION the peering value has to be set to FOR_SELF or default to FOR_SELF when unset." ], "type": "string" }, @@ -1603,6 +1609,21 @@ }, "type": "object" }, +"Migration": { +"description": "Specification for migration with source and target resource names.", +"id": "Migration", +"properties": { +"source": { +"description": "Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}", +"type": "string" +}, +"target": { +"description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", +"type": "string" +} +}, +"type": "object" +}, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index f398788f46e..4d3c5d3b694 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240725", +"revision": "20240807", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1142,7 +1142,9 @@ false "CLOUD_NAT_NO_ADDRESSES", "ROUTING_LOOP", "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE", -"LOAD_BALANCER_BACKEND_INVALID_NETWORK" +"LOAD_BALANCER_BACKEND_INVALID_NETWORK", +"BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED", +"DESTINATION_IS_PRIVATE_NAT_IP_RANGE" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1210,7 +1212,9 @@ false "Packet sent to Cloud Nat without active NAT IPs.", "Packet is stuck in a routing loop.", "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", -"Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer." +"Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", +"Packet is dropped due to a backend service named port not being defined on the instance group level.", +"Packet is dropped due to a destination IP range being part of a Private NAT IP range." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 988c8495de7..e6fe66b3d87 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -585,13 +585,180 @@ } } } +}, +"vpcFlowLogsConfigs": { +"methods": { +"create": { +"description": "Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs", +"httpMethod": "POST", +"id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id}/locations/global`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"vpcFlowLogsConfigId": { +"description": "Required. ID of the `VpcFlowLogsConfig`.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/vpcFlowLogsConfigs", +"request": { +"$ref": "VpcFlowLogsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a specific `VpcFlowLogsConfig`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", +"httpMethod": "DELETE", +"id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the details of a specific `VpcFlowLogsConfig`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "VpcFlowLogsConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all `VpcFlowLogsConfigs` in a given project.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs", +"httpMethod": "GET", +"id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field to use to sort the list.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Number of `VpcFlowLogsConfigs` to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token from an earlier query, as returned in `next_page_token`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/vpcFlowLogsConfigs", +"response": { +"$ref": "ListVpcFlowLogsConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", +"httpMethod": "PATCH", +"id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "VpcFlowLogsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } } } } }, -"revision": "20240725", +"revision": "20240807", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1147,7 +1314,9 @@ false "CLOUD_NAT_NO_ADDRESSES", "ROUTING_LOOP", "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE", -"LOAD_BALANCER_BACKEND_INVALID_NETWORK" +"LOAD_BALANCER_BACKEND_INVALID_NETWORK", +"BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED", +"DESTINATION_IS_PRIVATE_NAT_IP_RANGE" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1215,7 +1384,9 @@ false "Packet sent to Cloud Nat without active NAT IPs.", "Packet is stuck in a routing loop.", "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", -"Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer." +"Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", +"Packet is dropped due to a backend service named port not being defined on the instance group level.", +"Packet is dropped due to a destination IP range being part of a Private NAT IP range." ], "type": "string" }, @@ -1821,6 +1992,31 @@ false }, "type": "object" }, +"ListVpcFlowLogsConfigsResponse": { +"description": "Response for the `ListVpcFlowLogsConfigs` method.", +"id": "ListVpcFlowLogsConfigsResponse", +"properties": { +"nextPageToken": { +"description": "Page token to fetch the next set of configurations.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached (when querying all locations with `-`).", +"items": { +"type": "string" +}, +"type": "array" +}, +"vpcFlowLogsConfigs": { +"description": "List of VPC Flow Log configurations.", +"items": { +"$ref": "VpcFlowLogsConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "LoadBalancerBackend": { "description": "For display only. Metadata associated with a specific load balancer backend.", "id": "LoadBalancerBackend", @@ -2895,6 +3091,116 @@ false }, "type": "object" }, +"VpcFlowLogsConfig": { +"description": "A configuration to generate VPC Flow Logs.", +"id": "VpcFlowLogsConfig", +"properties": { +"aggregationInterval": { +"description": "Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.", +"enum": [ +"AGGREGATION_INTERVAL_UNSPECIFIED", +"INTERVAL_5_SEC", +"INTERVAL_30_SEC", +"INTERVAL_1_MIN", +"INTERVAL_5_MIN", +"INTERVAL_10_MIN", +"INTERVAL_15_MIN" +], +"enumDescriptions": [ +"If not specified, will default to INTERVAL_5_SEC.", +"Aggregate logs in 5s intervals.", +"Aggregate logs in 30s intervals.", +"Aggregate logs in 1m intervals.", +"Aggregate logs in 5m intervals.", +"Aggregate logs in 10m intervals.", +"Aggregate logs in 15m intervals." +], +"type": "string" +}, +"createTime": { +"description": "Output only. The time the config was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.", +"type": "string" +}, +"filterExpr": { +"description": "Optional. Export filter used to define which VPC Flow Logs should be logged.", +"type": "string" +}, +"flowSampling": { +"description": "Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.", +"format": "float", +"type": "number" +}, +"interconnectAttachment": { +"description": "Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user-provided metadata.", +"type": "object" +}, +"metadata": { +"description": "Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.", +"enum": [ +"METADATA_UNSPECIFIED", +"INCLUDE_ALL_METADATA", +"EXCLUDE_ALL_METADATA", +"CUSTOM_METADATA" +], +"enumDescriptions": [ +"If not specified, will default to INCLUDE_ALL_METADATA.", +"Include all metadata fields.", +"Exclude all metadata fields.", +"Include only custom fields (specified in metadata_fields)." +], +"type": "string" +}, +"metadataFields": { +"description": "Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", +"type": "string" +}, +"state": { +"description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"If not specified, will default to ENABLED.", +"When ENABLED, this configuration will generate logs.", +"When DISABLED, this configuration will not generate logs." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the config was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"vpnTunnel": { +"description": "Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}", +"type": "string" +} +}, +"type": "object" +}, "VpnGatewayInfo": { "description": "For display only. Metadata associated with a Compute Engine VPN gateway.", "id": "VpnGatewayInfo", diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index e19cf7f10aa..975e28954e0 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -170,7 +170,7 @@ } } }, -"revision": "20240725", +"revision": "20240813", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -367,7 +367,7 @@ "type": "object" }, "DeviceIntegrity": { -"description": "Contains the device attestation information. Next tag: 4", +"description": "Contains the device attestation information.", "id": "DeviceIntegrity", "properties": { "deviceRecall": { @@ -403,7 +403,7 @@ "type": "object" }, "DeviceRecall": { -"description": "Contains the recall bits per device set by the developer. Next tag: 3", +"description": "Contains the recall bits per device set by the developer.", "id": "DeviceRecall", "properties": { "values": { @@ -589,7 +589,7 @@ "id": "WriteDeviceRecallRequest", "properties": { "integrityToken": { -"description": "Required. Integrity token obtained from calling Play Integrity API. Note that the integrity token contains the existing device recall bits. The write will only succeed if those bits in the integrity token are up to date.", +"description": "Required. Integrity token obtained from calling Play Integrity API.", "type": "string" }, "newValues": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 870fdfcba66..e12402e2d5b 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -516,6 +516,42 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"listIpOverrides": { +"description": "Lists all IP overrides for a key.", +"flatPath": "v1/projects/{projectsId}/keys/{keysId}:listIpOverrides", +"httpMethod": "GET", +"id": "recaptchaenterprise.projects.keys.listIpOverrides", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of overrides to return. Default is 10. Max limit is 100. If the number of overrides is less than the page_size, all overrides are returned. If the page size is more than 100, it is coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous ListIpOverridesRequest, if any.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent key for which the IP overrides are listed, in the format `projects/{project}/keys/{key}`.", +"location": "path", +"pattern": "^projects/[^/]+/keys/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:listIpOverrides", +"response": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "migrate": { "description": "Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.", "flatPath": "v1/projects/{projectsId}/keys/{keysId}:migrate", @@ -578,6 +614,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"removeIpOverride": { +"description": "Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error will be returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error will be returned.", +"flatPath": "v1/projects/{projectsId}/keys/{keysId}:removeIpOverride", +"httpMethod": "POST", +"id": "recaptchaenterprise.projects.keys.removeIpOverride", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the key from which the IP override is removed, in the format `projects/{project}/keys/{key}`.", +"location": "path", +"pattern": "^projects/[^/]+/keys/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:removeIpOverride", +"request": { +"$ref": "GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest" +}, +"response": { +"$ref": "GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "retrieveLegacySecretKey": { "description": "Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.", "flatPath": "v1/projects/{projectsId}/keys/{keysId}:retrieveLegacySecretKey", @@ -722,7 +786,7 @@ } } }, -"revision": "20240804", +"revision": "20240811", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1538,6 +1602,24 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse": { +"description": "Response for ListIpOverrides.", +"id": "GoogleCloudRecaptchaenterpriseV1ListIpOverridesResponse", +"properties": { +"ipOverrides": { +"description": "IP Overrides details.", +"items": { +"$ref": "GoogleCloudRecaptchaenterpriseV1IpOverrideData" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to retrieve the next page of results. If this field is empty, no keys remain in the results.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1ListKeysResponse": { "description": "Response to request to list keys in a project.", "id": "GoogleCloudRecaptchaenterpriseV1ListKeysResponse", @@ -1710,6 +1792,23 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest": { +"description": "The removeIpOverride request message.", +"id": "GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest", +"properties": { +"ipOverrideData": { +"$ref": "GoogleCloudRecaptchaenterpriseV1IpOverrideData", +"description": "Required. IP override to be removed from the key." +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse": { +"description": "Response for RemoveIpOverride.", +"id": "GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest": { "description": "The reorder firewall policies request message.", "id": "GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest", diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index bd9743f2767..1539b701532 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240711", +"revision": "20240812", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -987,6 +987,10 @@ "readOnly": true, "type": "string" }, +"crossClusterReplicationConfig": { +"$ref": "CrossClusterReplicationConfig", +"description": "Optional. Cross cluster replication config." +}, "deletionProtectionEnabled": { "description": "Optional. The delete operation will fail when the value is set to true.", "type": "boolean" @@ -1059,7 +1063,7 @@ "type": "integer" }, "shardCount": { -"description": "Required. Number of shards for the Redis cluster.", +"description": "Optional. Number of shards for the Redis cluster.", "format": "int32", "type": "integer" }, @@ -1165,40 +1169,61 @@ }, "type": "object" }, -"CustomMetadataData": { -"description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", -"id": "CustomMetadataData", +"CrossClusterReplicationConfig": { +"description": "Cross cluster replication config.", +"id": "CrossClusterReplicationConfig", "properties": { -"databaseMetadata": { +"clusterRole": { +"description": "The role of the cluster in cross cluster replication.", +"enum": [ +"CLUSTER_ROLE_UNSPECIFIED", +"NONE", +"PRIMARY", +"SECONDARY" +], +"enumDescriptions": [ +"Cluster role is not set. The behavior is equivalent to NONE.", +"This cluster does not participate in cross cluster replication. It is an independent cluster and does not replicate to or from any other clusters.", +"A cluster that allows both reads and writes. Any data written to this cluster is also replicated to the attached secondary clusters.", +"A cluster that allows only reads and replicates data from a primary cluster." +], +"type": "string" +}, +"membership": { +"$ref": "Membership", +"description": "Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication.", +"readOnly": true +}, +"primaryCluster": { +"$ref": "RemoteCluster", +"description": "Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster." +}, +"secondaryClusters": { +"description": "List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster.", "items": { -"$ref": "DatabaseMetadata" +"$ref": "RemoteCluster" }, "type": "array" +}, +"updateTime": { +"description": "Output only. The last time cross cluster replication config was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"DatabaseMetadata": { -"description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", -"id": "DatabaseMetadata", +"CustomMetadataData": { +"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"id": "CustomMetadataData", "properties": { -"backupConfiguration": { -"$ref": "BackupConfiguration", -"description": "Backup configuration for this database" -}, -"backupRun": { -"$ref": "BackupRun", -"description": "Information about the last backup attempt for this database" -}, -"product": { -"$ref": "Product" -}, -"resourceId": { -"$ref": "DatabaseResourceId" +"internalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", +"items": { +"$ref": "InternalResourceMetadata" }, -"resourceName": { -"description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", -"type": "string" +"type": "array" } }, "type": "object" @@ -1340,6 +1365,24 @@ "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, +"signalSeverity": { +"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"enum": [ +"SIGNAL_SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"This value is used for findings when a source doesn't write a severity value.", +"A critical vulnerability is easily discoverable by an external actor, exploitable.", +"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", +"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", +"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +], +"type": "string" +}, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -1636,7 +1679,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -2570,6 +2613,31 @@ false }, "type": "object" }, +"InternalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"id": "InternalResourceMetadata", +"properties": { +"backupConfiguration": { +"$ref": "BackupConfiguration", +"description": "Backup configuration for this database" +}, +"backupRun": { +"$ref": "BackupRun", +"description": "Information about the last backup attempt for this database" +}, +"product": { +"$ref": "Product" +}, +"resourceId": { +"$ref": "DatabaseResourceId" +}, +"resourceName": { +"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"type": "string" +} +}, +"type": "object" +}, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2780,6 +2848,26 @@ false }, "type": "object" }, +"Membership": { +"description": "An output only view of all the member clusters participating in the cross cluster replication.", +"id": "Membership", +"properties": { +"primaryCluster": { +"$ref": "RemoteCluster", +"description": "Output only. The primary cluster that acts as the source of replication for the secondary clusters.", +"readOnly": true +}, +"secondaryClusters": { +"description": "Output only. The list of secondary clusters replicating from the primary cluster.", +"items": { +"$ref": "RemoteCluster" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "NodeInfo": { "description": "Node specific properties.", "id": "NodeInfo", @@ -3050,7 +3138,9 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_OTHER" +"ENGINE_OTHER", +"ENGINE_FIRESTORE_WITH_NATIVE_MODE", +"ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -3066,6 +3156,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -3082,7 +3174,9 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." +"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", +"Firestore with native mode.", +"Firestore with datastore mode." ], "type": "string" }, @@ -3099,7 +3193,8 @@ false "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", -"PRODUCT_TYPE_OTHER" +"PRODUCT_TYPE_OTHER", +"PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -3112,6 +3207,7 @@ false, true, false, false, +false, false ], "enumDescriptions": [ @@ -3125,7 +3221,8 @@ false "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", -"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." +"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", +"Firestore product area in GCP." ], "type": "string" }, @@ -3238,6 +3335,22 @@ false }, "type": "object" }, +"RemoteCluster": { +"description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", +"id": "RemoteCluster", +"properties": { +"cluster": { +"description": "The full resource path of the remote cluster in the format: projects//locations//clusters/", +"type": "string" +}, +"uid": { +"description": "Output only. The unique identifier of the remote cluster.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index ec5d28e2022..dcbd315705a 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240711", +"revision": "20240812", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -987,6 +987,10 @@ "readOnly": true, "type": "string" }, +"crossClusterReplicationConfig": { +"$ref": "CrossClusterReplicationConfig", +"description": "Optional. Cross cluster replication config." +}, "deletionProtectionEnabled": { "description": "Optional. The delete operation will fail when the value is set to true.", "type": "boolean" @@ -1059,7 +1063,7 @@ "type": "integer" }, "shardCount": { -"description": "Required. Number of shards for the Redis cluster.", +"description": "Optional. Number of shards for the Redis cluster.", "format": "int32", "type": "integer" }, @@ -1165,40 +1169,61 @@ }, "type": "object" }, -"CustomMetadataData": { -"description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", -"id": "CustomMetadataData", +"CrossClusterReplicationConfig": { +"description": "Cross cluster replication config.", +"id": "CrossClusterReplicationConfig", "properties": { -"databaseMetadata": { +"clusterRole": { +"description": "The role of the cluster in cross cluster replication.", +"enum": [ +"CLUSTER_ROLE_UNSPECIFIED", +"NONE", +"PRIMARY", +"SECONDARY" +], +"enumDescriptions": [ +"Cluster role is not set. The behavior is equivalent to NONE.", +"This cluster does not participate in cross cluster replication. It is an independent cluster and does not replicate to or from any other clusters.", +"A cluster that allows both reads and writes. Any data written to this cluster is also replicated to the attached secondary clusters.", +"A cluster that allows only reads and replicates data from a primary cluster." +], +"type": "string" +}, +"membership": { +"$ref": "Membership", +"description": "Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication.", +"readOnly": true +}, +"primaryCluster": { +"$ref": "RemoteCluster", +"description": "Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster." +}, +"secondaryClusters": { +"description": "List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster.", "items": { -"$ref": "DatabaseMetadata" +"$ref": "RemoteCluster" }, "type": "array" +}, +"updateTime": { +"description": "Output only. The last time cross cluster replication config was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" } }, "type": "object" }, -"DatabaseMetadata": { -"description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", -"id": "DatabaseMetadata", +"CustomMetadataData": { +"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", +"id": "CustomMetadataData", "properties": { -"backupConfiguration": { -"$ref": "BackupConfiguration", -"description": "Backup configuration for this database" -}, -"backupRun": { -"$ref": "BackupRun", -"description": "Information about the last backup attempt for this database" -}, -"product": { -"$ref": "Product" -}, -"resourceId": { -"$ref": "DatabaseResourceId" +"internalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", +"items": { +"$ref": "InternalResourceMetadata" }, -"resourceName": { -"description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", -"type": "string" +"type": "array" } }, "type": "object" @@ -1340,6 +1365,24 @@ "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, +"signalSeverity": { +"description": "The severity of the signal, such as if it's a HIGH or LOW severity.", +"enum": [ +"SIGNAL_SEVERITY_UNSPECIFIED", +"CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"This value is used for findings when a source doesn't write a severity value.", +"A critical vulnerability is easily discoverable by an external actor, exploitable.", +"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", +"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", +"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." +], +"type": "string" +}, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -1636,7 +1679,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -2577,6 +2620,31 @@ false }, "type": "object" }, +"InternalResourceMetadata": { +"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", +"id": "InternalResourceMetadata", +"properties": { +"backupConfiguration": { +"$ref": "BackupConfiguration", +"description": "Backup configuration for this database" +}, +"backupRun": { +"$ref": "BackupRun", +"description": "Information about the last backup attempt for this database" +}, +"product": { +"$ref": "Product" +}, +"resourceId": { +"$ref": "DatabaseResourceId" +}, +"resourceName": { +"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", +"type": "string" +} +}, +"type": "object" +}, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2787,6 +2855,26 @@ false }, "type": "object" }, +"Membership": { +"description": "An output only view of all the member clusters participating in the cross cluster replication.", +"id": "Membership", +"properties": { +"primaryCluster": { +"$ref": "RemoteCluster", +"description": "Output only. The primary cluster that acts as the source of replication for the secondary clusters.", +"readOnly": true +}, +"secondaryClusters": { +"description": "Output only. The list of secondary clusters replicating from the primary cluster.", +"items": { +"$ref": "RemoteCluster" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "NodeInfo": { "description": "Node specific properties.", "id": "NodeInfo", @@ -3057,7 +3145,9 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_OTHER" +"ENGINE_OTHER", +"ENGINE_FIRESTORE_WITH_NATIVE_MODE", +"ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -3073,6 +3163,8 @@ false, false, false, false, +false, +false, false ], "enumDescriptions": [ @@ -3089,7 +3181,9 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." +"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", +"Firestore with native mode.", +"Firestore with datastore mode." ], "type": "string" }, @@ -3106,7 +3200,8 @@ false "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", -"PRODUCT_TYPE_OTHER" +"PRODUCT_TYPE_OTHER", +"PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -3119,6 +3214,7 @@ false, true, false, false, +false, false ], "enumDescriptions": [ @@ -3132,7 +3228,8 @@ false "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", -"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." +"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", +"Firestore product area in GCP." ], "type": "string" }, @@ -3245,6 +3342,22 @@ false }, "type": "object" }, +"RemoteCluster": { +"description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", +"id": "RemoteCluster", +"properties": { +"cluster": { +"description": "The full resource path of the remote cluster in the format: projects//locations//clusters/", +"type": "string" +}, +"uid": { +"description": "Output only. The unique identifier of the remote cluster.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index c824a710383..faefc2a57ea 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2092,7 +2092,7 @@ } } }, -"revision": "20240801", +"revision": "20240816", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4641,7 +4641,7 @@ "id": "GoogleCloudRetailV2RuleForceReturnFacetAction", "properties": { "facetPositionAdjustments": { -"description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.", +"description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.", "items": { "$ref": "GoogleCloudRetailV2RuleForceReturnFacetActionFacetPositionAdjustment" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 226156a504c..2c8adee4a2a 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2613,7 +2613,7 @@ } } }, -"revision": "20240801", +"revision": "20240816", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6494,7 +6494,7 @@ "id": "GoogleCloudRetailV2alphaRuleForceReturnFacetAction", "properties": { "facetPositionAdjustments": { -"description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.", +"description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.", "items": { "$ref": "GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment" }, diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 45728e7bf30..f1d4b1123f2 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2237,7 +2237,7 @@ } } }, -"revision": "20240801", +"revision": "20240816", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6442,7 +6442,7 @@ "id": "GoogleCloudRetailV2betaRuleForceReturnFacetAction", "properties": { "facetPositionAdjustments": { -"description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 3 instances here.", +"description": "Each instance corresponds to a force return attribute for the given condition. There can't be more 15 instances here.", "items": { "$ref": "GoogleCloudRetailV2betaRuleForceReturnFacetActionFacetPositionAdjustment" }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 9adf39bd8ed..f1a225531b9 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -416,6 +416,38 @@ } }, "resources": { +"builds": { +"methods": { +"submit": { +"description": "Submits a build in a given project.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/builds:submit", +"httpMethod": "POST", +"id": "run.projects.locations.builds.submit", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project and location to build in. Location must be a region, e.g., 'us-central1' or 'global' if the global builder is to be used. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/builds:submit", +"request": { +"$ref": "GoogleCloudRunV2SubmitBuildRequest" +}, +"response": { +"$ref": "GoogleCloudRunV2SubmitBuildResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "jobs": { "methods": { "create": { @@ -1494,7 +1526,7 @@ } } }, -"revision": "20240802", +"revision": "20240809", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -1516,6 +1548,41 @@ }, "type": "object" }, +"GoogleCloudRunV2BuildpacksBuild": { +"description": "Build the source using Buildpacks.", +"id": "GoogleCloudRunV2BuildpacksBuild", +"properties": { +"baseImage": { +"description": "Optional. The base image used to opt into automatic base image updates.", +"type": "string" +}, +"cacheImageUri": { +"description": "Optional. cache_image_uri is the GCR/AR URL where the cache image will be stored. cache_image_uri is optional and omitting it will disable caching. This URL must be stable across builds. It is used to derive a build-specific temporary URL by substituting the tag with the build ID. The build will clean up the temporary image on a best-effort basis.", +"type": "string" +}, +"enableAutomaticUpdates": { +"description": "Optional. Whether or not the application container will be enrolled in automatic base image updates. When true, the application will be built on a scratch base image, so the base layers can be appended at run time.", +"type": "boolean" +}, +"environmentVariables": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User-provided build-time environment variables.", +"type": "object" +}, +"functionTarget": { +"description": "Optional. Name of the function target if the source is a function source. Required for function builds.", +"type": "string" +}, +"runtime": { +"deprecated": true, +"description": "The runtime name, e.g. 'go113'. Leave blank for generic builds.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRunV2CancelExecutionRequest": { "description": "Request message for deleting an Execution.", "id": "GoogleCloudRunV2CancelExecutionRequest", @@ -1812,6 +1879,12 @@ }, "type": "object" }, +"GoogleCloudRunV2DockerBuild": { +"description": "Build the source using Docker. This means the source has a Dockerfile.", +"id": "GoogleCloudRunV2DockerBuild", +"properties": {}, +"type": "object" +}, "GoogleCloudRunV2EmptyDirVolumeSource": { "description": "In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).", "id": "GoogleCloudRunV2EmptyDirVolumeSource", @@ -1844,7 +1917,7 @@ "type": "string" }, "value": { -"description": "Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route 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. Defaults to \"\", and the maximum length is 32768 bytes.", +"description": "Literal value of the environment variable. Defaults to \"\", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run.", "type": "string" }, "valueSource": { @@ -3321,6 +3394,79 @@ }, "type": "object" }, +"GoogleCloudRunV2StorageSource": { +"description": "Location of the source in an archive file in Google Cloud Storage.", +"id": "GoogleCloudRunV2StorageSource", +"properties": { +"bucket": { +"description": "Required. Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", +"type": "string" +}, +"generation": { +"description": "Optional. Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", +"format": "int64", +"type": "string" +}, +"object": { +"description": "Required. Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRunV2SubmitBuildRequest": { +"description": "Request message for submitting a Build.", +"id": "GoogleCloudRunV2SubmitBuildRequest", +"properties": { +"buildpackBuild": { +"$ref": "GoogleCloudRunV2BuildpacksBuild", +"description": "Build the source using Buildpacks." +}, +"dockerBuild": { +"$ref": "GoogleCloudRunV2DockerBuild", +"description": "Build the source using Docker. This means the source has a Dockerfile." +}, +"imageUri": { +"description": "Required. Artifact Registry URI to store the built image.", +"type": "string" +}, +"serviceAccount": { +"description": "Optional. The service account to use for the build. If not set, the default Cloud Build service account for the project will be used.", +"type": "string" +}, +"storageSource": { +"$ref": "GoogleCloudRunV2StorageSource", +"description": "Required. Source for the build." +}, +"tags": { +"description": "Optional. Additional tags to annotate the build.", +"items": { +"type": "string" +}, +"type": "array" +}, +"workerPool": { +"description": "Optional. Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRunV2SubmitBuildResponse": { +"description": "Response message for submitting a Build.", +"id": "GoogleCloudRunV2SubmitBuildResponse", +"properties": { +"baseImageUri": { +"description": "URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.", +"type": "string" +}, +"buildOperation": { +"$ref": "GoogleLongrunningOperation", +"description": "Cloud Build operation to be polled via CloudBuild API." +} +}, +"type": "object" +}, "GoogleCloudRunV2TCPSocketAction": { "description": "TCPSocketAction describes an action based on opening a socket", "id": "GoogleCloudRunV2TCPSocketAction", diff --git a/googleapiclient/discovery_cache/documents/searchads360.v0.json b/googleapiclient/discovery_cache/documents/searchads360.v0.json index 3788314434f..99c262bad08 100644 --- a/googleapiclient/discovery_cache/documents/searchads360.v0.json +++ b/googleapiclient/discovery_cache/documents/searchads360.v0.json @@ -260,7 +260,7 @@ } } }, -"revision": "20240429", +"revision": "20240808", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -346,6 +346,17 @@ }, "type": "object" }, +"GoogleAdsSearchads360V0Common__AdTextAsset": { +"description": "A text asset used inside an ad.", +"id": "GoogleAdsSearchads360V0Common__AdTextAsset", +"properties": { +"text": { +"description": "Asset text.", +"type": "string" +} +}, +"type": "object" +}, "GoogleAdsSearchads360V0Common__AgeRangeInfo": { "description": "An age range criterion.", "id": "GoogleAdsSearchads360V0Common__AgeRangeInfo", @@ -1012,6 +1023,11 @@ "format": "double", "type": "number" }, +"averageQualityScore": { +"description": "The average quality score.", +"format": "double", +"type": "number" +}, "clicks": { "description": "The number of clicks.", "format": "int64", @@ -1540,6 +1556,20 @@ "format": "int64", "type": "string" }, +"descriptions": { +"description": "List of text assets for descriptions. When the ad serves the descriptions will be selected from this list.", +"items": { +"$ref": "GoogleAdsSearchads360V0Common__AdTextAsset" +}, +"type": "array" +}, +"headlines": { +"description": "List of text assets for headlines. When the ad serves the headlines will be selected from this list.", +"items": { +"$ref": "GoogleAdsSearchads360V0Common__AdTextAsset" +}, +"type": "array" +}, "path1": { "description": "Text appended to the auto-generated visible URL with a delimiter.", "type": "string" @@ -1738,6 +1768,27 @@ ], "type": "string" }, +"geoTargetCity": { +"description": "Resource name of the geo target constant that represents a city.", +"type": "string" +}, +"geoTargetCountry": { +"description": "Resource name of the geo target constant that represents a country.", +"type": "string" +}, +"geoTargetMetro": { +"description": "Resource name of the geo target constant that represents a metro.", +"type": "string" +}, +"geoTargetRegion": { +"description": "Resource name of the geo target constant that represents a region.", +"type": "string" +}, +"hour": { +"description": "Hour of day as a number between 0 and 23, inclusive.", +"format": "int32", +"type": "integer" +}, "keyword": { "$ref": "GoogleAdsSearchads360V0Common__Keyword", "description": "Keyword criterion." @@ -2144,7 +2195,7 @@ }, "targetSpendMicros": { "deprecated": true, -"description": "The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.", +"description": "Deprecated: The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.", "format": "int64", "type": "string" } @@ -2181,7 +2232,7 @@ "id": "GoogleAdsSearchads360V0Common__TextLabel", "properties": { "backgroundColor": { -"description": "Background color of the label in RGB format. This string must match the regular expression '^\\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.", +"description": "Background color of the label in HEX format. This string must match the regular expression '^\\#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$'. Note: The background color may not be visible for manager accounts.", "type": "string" }, "description": { @@ -3032,7 +3083,7 @@ "type": "object" }, "GoogleAdsSearchads360V0Errors__SearchAds360Error": { -"description": "SearchAds360-specific error.", +"description": "Search Ads 360-specific error.", "id": "GoogleAdsSearchads360V0Errors__SearchAds360Error", "properties": { "details": { @@ -3893,7 +3944,8 @@ "DISCOVERY_MULTI_ASSET_AD", "DISCOVERY_CAROUSEL_AD", "TRAVEL_AD", -"DISCOVERY_VIDEO_RESPONSIVE_AD" +"DISCOVERY_VIDEO_RESPONSIVE_AD", +"MULTIMEDIA_AD" ], "enumDescriptions": [ "No value has been specified.", @@ -3929,7 +3981,8 @@ "Discovery multi asset ad.", "Discovery carousel ad.", "Travel ad.", -"Discovery video responsive ad." +"Discovery video responsive ad.", +"Multimedia ad." ], "readOnly": true, "type": "string" @@ -4145,7 +4198,7 @@ false "type": "string" }, "engineId": { -"description": "Output only. ID of the ad in the external engine account. This field is for SearchAds 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-SearchAds 360 entity, use \"ad_group_ad.ad.id\" instead.", +"description": "Output only. ID of the ad in the external engine account. This field is for Search Ads 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc. For non-Search Ads 360 entity, use \"ad_group_ad.ad.id\" instead.", "readOnly": true, "type": "string" }, @@ -5512,7 +5565,8 @@ false "VIDEO_SEQUENCE", "APP_CAMPAIGN_FOR_PRE_REGISTRATION", "VIDEO_REACH_TARGET_FREQUENCY", -"TRAVEL_ACTIVITIES" +"TRAVEL_ACTIVITIES", +"SOCIAL_FACEBOOK_TRACKING_ONLY" ], "enumDescriptions": [ "Not specified.", @@ -5535,7 +5589,8 @@ false "Video campaigns with sequence video ads.", "App Campaign for pre registration, specialized for advertising mobile app pre-registration, that targets multiple advertising channels across Google Play, YouTube and Display Network.", "Video reach campaign with Target Frequency bidding strategy.", -"Travel Activities campaigns." +"Travel Activities campaigns.", +"Facebook tracking only social campaigns." ], "type": "string" }, @@ -5555,7 +5610,8 @@ false "PERFORMANCE_MAX", "LOCAL_SERVICES", "DISCOVERY", -"TRAVEL" +"TRAVEL", +"SOCIAL" ], "enumDescriptions": [ "Not specified.", @@ -5571,7 +5627,8 @@ false "Performance Max campaigns.", "Local services campaigns.", "Discovery campaigns.", -"Travel campaigns." +"Travel campaigns.", +"Social campaigns." ], "type": "string" }, @@ -6470,7 +6527,7 @@ false "type": "string" }, "merchantId": { -"description": "Output only. The SearchAds360 inventory account ID containing the product that was clicked on. SearchAds360 generates this ID when you link an inventory account in SearchAds360.", +"description": "Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.", "format": "int64", "readOnly": true, "type": "string" @@ -6535,7 +6592,7 @@ false "type": "string" }, "visitId": { -"description": "Output only. The SearchAds360 visit ID that the conversion is attributed to.", +"description": "Output only. The Search Ads 360 visit ID that the conversion is attributed to.", "format": "int64", "readOnly": true, "type": "string" @@ -7327,6 +7384,11 @@ false "description": "Immutable. Name of the resource. CustomerManagerLink resource names have the form: `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`", "type": "string" }, +"startTime": { +"description": "Output only. The timestamp when the CustomerManagerLink was created. The timestamp is in the customer's time zone and in \"yyyy-MM-dd HH:mm:ss\" format.", +"readOnly": true, +"type": "string" +}, "status": { "description": "Status of the link between the customer and the manager.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 31682d8e1fc..2353cd955d2 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -15,6 +15,13 @@ "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/security-command-center", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", +"location": "me-central2" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -6027,7 +6034,7 @@ } } }, -"revision": "20240806", +"revision": "20240809", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 5ef9812511e..acff710c501 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -15,6 +15,13 @@ "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/security-command-center", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", +"location": "me-central2" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -896,7 +903,7 @@ } } }, -"revision": "20240806", +"revision": "20240809", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index 6864b989273..7be6ea51b73 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -15,6 +15,13 @@ "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/security-command-center", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", +"location": "me-central2" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -1906,7 +1913,7 @@ } } }, -"revision": "20240806", +"revision": "20240809", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 8d1840f139a..8c6df13589a 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20240712", +"revision": "20240811", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -488,6 +488,83 @@ }, "type": "object" }, +"Analysis": { +"description": "A message to group the analysis information.", +"id": "Analysis", +"properties": { +"analysis": { +"$ref": "AnalysisResult", +"description": "Output only. Analysis result of updating a policy.", +"readOnly": true +}, +"analysisType": { +"description": "Output only. The type of analysis.", +"enum": [ +"ANALYSIS_TYPE_UNSPECIFIED", +"ANALYSIS_TYPE_DEPENDENCY", +"ANALYSIS_TYPE_RESOURCE_USAGE" +], +"enumDescriptions": [ +"Unspecified analysis type. Do not use.", +"The analysis of service dependencies.", +"The analysis of service resource usage." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc.", +"readOnly": true, +"type": "string" +}, +"service": { +"description": "The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"AnalysisResult": { +"description": "An analysis result including blockers and warnings.", +"id": "AnalysisResult", +"properties": { +"blockers": { +"description": "Blocking information that would prevent the policy changes at runtime.", +"items": { +"$ref": "Impact" +}, +"type": "array" +}, +"warnings": { +"description": "Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime.", +"items": { +"$ref": "Impact" +}, +"type": "array" +} +}, +"type": "object" +}, +"AnalyzeConsumerPolicyMetadata": { +"description": "Metadata for the `AnalyzeConsumerPolicy` method.", +"id": "AnalyzeConsumerPolicyMetadata", +"properties": {}, +"type": "object" +}, +"AnalyzeConsumerPolicyResponse": { +"description": "The response of analyzing a consumer policy update.", +"id": "AnalyzeConsumerPolicyResponse", +"properties": { +"analysis": { +"description": "The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers.", +"items": { +"$ref": "Analysis" +}, +"type": "array" +} +}, +"type": "object" +}, "Api": { "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", "id": "Api", @@ -2020,6 +2097,31 @@ }, "type": "object" }, +"Impact": { +"description": "A message to group impacts of updating a policy.", +"id": "Impact", +"properties": { +"detail": { +"description": "Output only. User friendly impact detail in a free form message.", +"readOnly": true, +"type": "string" +}, +"impactType": { +"description": "Output only. The type of impact.", +"enum": [ +"IMPACT_TYPE_UNSPECIFIED", +"DEPENDENCY_MISSING_DEPENDENCIES" +], +"enumDescriptions": [ +"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE ...", +"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ImportAdminOverridesMetadata": { "description": "Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides.", "id": "ImportAdminOverridesMetadata", diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 6037b5a29ed..c2dd4e54bc7 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20240712", +"revision": "20240811", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1026,6 +1026,83 @@ }, "type": "object" }, +"Analysis": { +"description": "A message to group the analysis information.", +"id": "Analysis", +"properties": { +"analysis": { +"$ref": "AnalysisResult", +"description": "Output only. Analysis result of updating a policy.", +"readOnly": true +}, +"analysisType": { +"description": "Output only. The type of analysis.", +"enum": [ +"ANALYSIS_TYPE_UNSPECIFIED", +"ANALYSIS_TYPE_DEPENDENCY", +"ANALYSIS_TYPE_RESOURCE_USAGE" +], +"enumDescriptions": [ +"Unspecified analysis type. Do not use.", +"The analysis of service dependencies.", +"The analysis of service resource usage." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc.", +"readOnly": true, +"type": "string" +}, +"service": { +"description": "The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"AnalysisResult": { +"description": "An analysis result including blockers and warnings.", +"id": "AnalysisResult", +"properties": { +"blockers": { +"description": "Blocking information that would prevent the policy changes at runtime.", +"items": { +"$ref": "Impact" +}, +"type": "array" +}, +"warnings": { +"description": "Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime.", +"items": { +"$ref": "Impact" +}, +"type": "array" +} +}, +"type": "object" +}, +"AnalyzeConsumerPolicyMetadata": { +"description": "Metadata for the `AnalyzeConsumerPolicy` method.", +"id": "AnalyzeConsumerPolicyMetadata", +"properties": {}, +"type": "object" +}, +"AnalyzeConsumerPolicyResponse": { +"description": "The response of analyzing a consumer policy update.", +"id": "AnalyzeConsumerPolicyResponse", +"properties": { +"analysis": { +"description": "The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers.", +"items": { +"$ref": "Analysis" +}, +"type": "array" +} +}, +"type": "object" +}, "Api": { "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", "id": "Api", @@ -2597,6 +2674,31 @@ }, "type": "object" }, +"Impact": { +"description": "A message to group impacts of updating a policy.", +"id": "Impact", +"properties": { +"detail": { +"description": "Output only. User friendly impact detail in a free form message.", +"readOnly": true, +"type": "string" +}, +"impactType": { +"description": "Output only. The type of impact.", +"enum": [ +"IMPACT_TYPE_UNSPECIFIED", +"DEPENDENCY_MISSING_DEPENDENCIES" +], +"enumDescriptions": [ +"Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE ...", +"Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY" +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ImportAdminOverridesMetadata": { "description": "Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides.", "id": "ImportAdminOverridesMetadata", diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 901fff3d538..d656f5371e2 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -26,6 +26,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://spanner.me-central2.rep.googleapis.com/", "location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://spanner.us-west1.rep.googleapis.com/", +"location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -169,7 +174,7 @@ "instanceConfigs": { "methods": { "create": { -"description": "Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", +"description": "Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "POST", "id": "spanner.projects.instanceConfigs.create", @@ -178,7 +183,7 @@ ], "parameters": { "parent": { -"description": "Required. The name of the project in which to create the instance config. Values are of the form `projects/`.", +"description": "Required. The name of the project in which to create the instance configuration. Values are of the form `projects/`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -198,7 +203,7 @@ ] }, "delete": { -"description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", +"description": "Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "DELETE", "id": "spanner.projects.instanceConfigs.delete", @@ -207,7 +212,7 @@ ], "parameters": { "etag": { -"description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance configuration without checking the current status of the requested instance config.", +"description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration.", "location": "query", "type": "string" }, @@ -297,7 +302,7 @@ ] }, "patch": { -"description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", +"description": "Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "PATCH", "id": "spanner.projects.instanceConfigs.patch", @@ -748,7 +753,7 @@ ] }, "move": { -"description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", +"description": "Moves an instance to the target instance configuration. You can use the returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup` * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. If not cancelled, upon completion of the returned operation: * The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration. Authorization requires the `spanner.instances.update` permission on the resource instance. For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance).", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:move", "httpMethod": "POST", "id": "spanner.projects.instances.move", @@ -3254,7 +3259,7 @@ } } }, -"revision": "20240731", +"revision": "20240807", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -3366,11 +3371,28 @@ "readOnly": true, "type": "array" }, +"exclusiveSizeBytes": { +"description": "Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "expireTime": { "description": "Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.", "format": "google-datetime", "type": "string" }, +"freeableSizeBytes": { +"description": "Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"incrementalBackupChainId": { +"description": "Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`.", +"readOnly": true, +"type": "string" +}, "maxExpireTime": { "description": "Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`.", "format": "google-datetime", @@ -3381,6 +3403,12 @@ "description": "Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.", "type": "string" }, +"oldestVersionTime": { +"description": "Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "referencingBackups": { "description": "Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.", "items": { @@ -3398,7 +3426,7 @@ "type": "array" }, "sizeBytes": { -"description": "Output only. Size of the backup in bytes.", +"description": "Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain.", "format": "int64", "readOnly": true, "type": "string" @@ -3463,6 +3491,10 @@ "$ref": "FullBackupSpec", "description": "The schedule creates only full backups." }, +"incrementalBackupSpec": { +"$ref": "IncrementalBackupSpec", +"description": "The schedule creates incremental backup chains." +}, "name": { "description": "Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.", "type": "string" @@ -3989,7 +4021,7 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", -"description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." +"description": "Required. The `InstanceConfig` proto of the configuration to create. `instance_config.name` must be `/instanceConfigs/`. `instance_config.base_config` must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." }, "instanceConfigId": { "description": "Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations.", @@ -4680,6 +4712,12 @@ }, "type": "object" }, +"IncrementalBackupSpec": { +"description": "The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup.", +"id": "IncrementalBackupSpec", +"properties": {}, +"type": "object" +}, "IndexAdvice": { "description": "Recommendation to add new indexes to run queries more efficiently.", "id": "IndexAdvice", @@ -4750,6 +4788,22 @@ "description": "Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.", "type": "string" }, +"edition": { +"description": "Optional. The `Edition` of the current instance.", +"enum": [ +"EDITION_UNSPECIFIED", +"STANDARD", +"ENTERPRISE", +"ENTERPRISE_PLUS" +], +"enumDescriptions": [ +"Edition not specified.", +"Standard edition.", +"Enterprise edition.", +"Enterprise Plus edition." +], +"type": "string" +}, "endpointUris": { "description": "Deprecated. This field is not populated.", "items": { @@ -4787,12 +4841,12 @@ "type": "string" }, "nodeCount": { -"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", +"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, "processingUnits": { -"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", +"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, @@ -4829,7 +4883,7 @@ "type": "string" }, "configType": { -"description": "Output only. Whether this instance configuration is a Google- or user-managed configuration.", +"description": "Output only. Whether this instance configuration is a Google-managed or user-managed configuration.", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_MANAGED", @@ -4852,7 +4906,7 @@ "type": "string" }, "freeInstanceAvailability": { -"description": "Output only. Describes whether free instances are available to be created in this instance config.", +"description": "Output only. Describes whether free instances are available to be created in this instance configuration.", "enum": [ "FREE_INSTANCE_AVAILABILITY_UNSPECIFIED", "AVAILABLE", @@ -4862,9 +4916,9 @@ ], "enumDescriptions": [ "Not specified.", -"Indicates that free instances are available to be created in this instance config.", -"Indicates that free instances are not supported in this instance config.", -"Indicates that free instances are currently not available to be created in this instance config.", +"Indicates that free instances are available to be created in this instance configuration.", +"Indicates that free instances are not supported in this instance configuration.", +"Indicates that free instances are currently not available to be created in this instance configuration.", "Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances." ], "readOnly": true, @@ -4914,7 +4968,7 @@ "type": "string" }, "reconciling": { -"description": "Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config.", +"description": "Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.", "readOnly": true, "type": "boolean" }, @@ -5298,7 +5352,7 @@ "type": "string" }, "operations": { -"description": "The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", +"description": "The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the name of the instance configuration. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", "items": { "$ref": "Operation" }, @@ -5582,7 +5636,7 @@ "id": "MoveInstanceRequest", "properties": { "targetConfig": { -"description": "Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`.", +"description": "Required. The target instance configuration where to move the instance. Values are of the form `projects//instanceConfigs/`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 4473bd21aca..005a31cdc94 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -1180,66 +1180,6 @@ } } }, -"diskMigrationJobs": { -"methods": { -"cancel": { -"description": "Cancels the disk migration job.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", -"httpMethod": "POST", -"id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the DiskMigrationJob.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:cancel", -"request": { -"$ref": "CancelDiskMigrationJobRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"run": { -"description": "Runs the disk migration job.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", -"httpMethod": "POST", -"id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the DiskMigrationJob.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:run", -"request": { -"$ref": "RunDiskMigrationJobRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "migratingVms": { "methods": { "create": { @@ -2280,7 +2220,7 @@ } } }, -"revision": "20240712", +"revision": "20240808", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2461,11 +2401,6 @@ "description": "User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.", "type": "object" }, -"networkInsights": { -"$ref": "NetworkInsights", -"description": "Output only. Information about the network coniguration of the source. Only gatherred upon request.", -"readOnly": true -}, "publicIp": { "description": "Output only. The source's public IP. All communication initiated by this source will originate from this IP.", "readOnly": true, @@ -2968,12 +2903,6 @@ "properties": {}, "type": "object" }, -"CancelDiskMigrationJobRequest": { -"description": "Request message for 'CancelDiskMigrationJob' request.", -"id": "CancelDiskMigrationJobRequest", -"properties": {}, -"type": "object" -}, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3180,6 +3109,20 @@ "description": "Output only. The OS license returned from the adaptation module report.", "readOnly": true }, +"bootConversion": { +"description": "Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another.", +"enum": [ +"BOOT_CONVERSION_UNSPECIFIED", +"NONE", +"BIOS_TO_EFI" +], +"enumDescriptions": [ +"Unspecified conversion type.", +"No conversion.", +"Convert from BIOS to EFI." +], +"type": "string" +}, "bootOption": { "description": "Output only. The VM Boot Option, as set in the source VM.", "enum": [ @@ -3217,6 +3160,14 @@ ], "type": "string" }, +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI.", +"type": "boolean" +}, "encryption": { "$ref": "Encryption", "description": "Optional. Immutable. The encryption to apply to the VM disks." @@ -3313,6 +3264,20 @@ "$ref": "AppliedLicense", "description": "The OS license returned from the adaptation module report." }, +"bootConversion": { +"description": "Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another.", +"enum": [ +"BOOT_CONVERSION_UNSPECIFIED", +"NONE", +"BIOS_TO_EFI" +], +"enumDescriptions": [ +"Unspecified conversion type.", +"No conversion.", +"Convert from BIOS to EFI." +], +"type": "string" +}, "bootOption": { "description": "The VM Boot Option, as set in the source VM.", "enum": [ @@ -3349,6 +3314,14 @@ ], "type": "string" }, +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance has integrity monitoring enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance has vTPM enabled.", +"type": "boolean" +}, "encryption": { "$ref": "Encryption", "description": "Optional. The encryption to apply to the VM disks." @@ -3864,6 +3837,14 @@ "$ref": "ComputeScheduling", "description": "Optional. Compute instance scheduling information (if empty default is used)." }, +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance has integrity monitoring enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance has vTPM enabled.", +"type": "boolean" +}, "encryption": { "$ref": "Encryption", "description": "Optional. The encryption to apply to the VM." @@ -5007,23 +4988,6 @@ }, "type": "object" }, -"NetworkInsights": { -"description": "Information about the network coniguration of the source.", -"id": "NetworkInsights", -"properties": { -"sourceNetworkConfig": { -"description": "Output only. The gathered network configuration of the source. Presented in json format.", -"readOnly": true, -"type": "string" -}, -"sourceNetworkTerraform": { -"description": "Output only. The gathered network configuration of the source. Presented in terraform format.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "NetworkInterface": { "description": "NetworkInterface represents a NIC of a VM.", "id": "NetworkInterface", @@ -5041,7 +5005,7 @@ "type": "string" }, "networkTier": { -"description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", +"description": "Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM.", "enum": [ "COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", "NETWORK_TIER_STANDARD", @@ -5397,12 +5361,6 @@ "properties": {}, "type": "object" }, -"RunDiskMigrationJobRequest": { -"description": "Request message for 'RunDiskMigrationJobRequest' request.", -"id": "RunDiskMigrationJobRequest", -"properties": {}, -"type": "object" -}, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 59fa75be3ab..613e396d535 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -1180,66 +1180,6 @@ } } }, -"diskMigrationJobs": { -"methods": { -"cancel": { -"description": "Cancels the disk migration job.", -"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", -"httpMethod": "POST", -"id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the DiskMigrationJob.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha1/{+name}:cancel", -"request": { -"$ref": "CancelDiskMigrationJobRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"run": { -"description": "Runs the disk migration job.", -"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", -"httpMethod": "POST", -"id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the DiskMigrationJob.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha1/{+name}:run", -"request": { -"$ref": "RunDiskMigrationJobRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "migratingVms": { "methods": { "create": { @@ -2280,7 +2220,7 @@ } } }, -"revision": "20240712", +"revision": "20240808", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2461,11 +2401,6 @@ "description": "User specified tags to add to every M2VM generated resource in AWS. These tags will be set in addition to the default tags that are set as part of the migration process. The tags must not begin with the reserved prefix `m2vm`.", "type": "object" }, -"networkInsights": { -"$ref": "NetworkInsights", -"description": "Output only. Information about the network coniguration of the source. Only gatherred upon request.", -"readOnly": true -}, "publicIp": { "description": "Output only. The source's public IP. All communication initiated by this source will originate from this IP.", "readOnly": true, @@ -2968,12 +2903,6 @@ "properties": {}, "type": "object" }, -"CancelDiskMigrationJobRequest": { -"description": "Request message for 'CancelDiskMigrationJob' request.", -"id": "CancelDiskMigrationJobRequest", -"properties": {}, -"type": "object" -}, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3192,6 +3121,20 @@ "description": "Output only. The OS license returned from the adaptation module report.", "readOnly": true }, +"bootConversion": { +"description": "Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another.", +"enum": [ +"BOOT_CONVERSION_UNSPECIFIED", +"NONE", +"BIOS_TO_EFI" +], +"enumDescriptions": [ +"Unspecified conversion type.", +"No conversion.", +"Convert from BIOS to EFI." +], +"type": "string" +}, "bootOption": { "description": "Output only. The VM Boot Option, as set in the source VM.", "enum": [ @@ -3229,6 +3172,14 @@ ], "type": "string" }, +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance has integrity monitoring enabled. This can be set to true only if the VM boot option is EFI, and vTPM is enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance has vTPM enabled. This can be set to true only if the VM boot option is EFI.", +"type": "boolean" +}, "encryption": { "$ref": "Encryption", "description": "Optional. Immutable. The encryption to apply to the VM disks." @@ -3325,6 +3276,20 @@ "$ref": "AppliedLicense", "description": "The OS license returned from the adaptation module report." }, +"bootConversion": { +"description": "Optional. By default the virtual machine will keep its existing boot option. Setting this property will trigger an internal process which will convert the virtual machine from using the existing boot option to another.", +"enum": [ +"BOOT_CONVERSION_UNSPECIFIED", +"NONE", +"BIOS_TO_EFI" +], +"enumDescriptions": [ +"Unspecified conversion type.", +"No conversion.", +"Convert from BIOS to EFI." +], +"type": "string" +}, "bootOption": { "description": "The VM Boot Option, as set in the source VM.", "enum": [ @@ -3361,6 +3326,14 @@ ], "type": "string" }, +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance has integrity monitoring enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance has vTPM enabled.", +"type": "boolean" +}, "encryption": { "$ref": "Encryption", "description": "Optional. The encryption to apply to the VM disks." @@ -3899,6 +3872,14 @@ "$ref": "ComputeScheduling", "description": "Optional. Compute instance scheduling information (if empty default is used)." }, +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance has integrity monitoring enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance has vTPM enabled.", +"type": "boolean" +}, "encryption": { "$ref": "Encryption", "description": "Optional. The encryption to apply to the VM." @@ -5052,23 +5033,6 @@ }, "type": "object" }, -"NetworkInsights": { -"description": "Information about the network coniguration of the source.", -"id": "NetworkInsights", -"properties": { -"sourceNetworkConfig": { -"description": "Output only. The gathered network configuration of the source. Presented in json format.", -"readOnly": true, -"type": "string" -}, -"sourceNetworkTerraform": { -"description": "Output only. The gathered network configuration of the source. Presented in terraform format.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "NetworkInterface": { "description": "NetworkInterface represents a NIC of a VM.", "id": "NetworkInterface", @@ -5086,7 +5050,7 @@ "type": "string" }, "networkTier": { -"description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", +"description": "Optional. The networking tier used for optimizing connectivity between instances and systems on the internet. Applies only for external ephemeral IP addresses. If left empty, will default to PREMIUM.", "enum": [ "COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", "NETWORK_TIER_STANDARD", @@ -5448,12 +5412,6 @@ "properties": {}, "type": "object" }, -"RunDiskMigrationJobRequest": { -"description": "Request message for 'RunDiskMigrationJobRequest' request.", -"id": "RunDiskMigrationJobRequest", -"properties": {}, -"type": "object" -}, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index c5d009433df..8c2f5ee887b 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -1770,7 +1770,7 @@ "type": "string" }, "part": { -"description": "The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id and snippet.", +"description": "The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.", "location": "query", "repeated": true, "required": true, @@ -4072,7 +4072,7 @@ } } }, -"revision": "20240707", +"revision": "20240814", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -10259,6 +10259,18 @@ true "PlaylistStatus": { "id": "PlaylistStatus", "properties": { +"podcastStatus": { +"description": "The playlist's podcast status.", +"enum": [ +"enabled", +"disabled" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +}, "privacyStatus": { "description": "The playlist's privacy status.", "enum": [